Sending Event Callbacks Oracle Fusion Middleware Online Documentation Library

Using the Callback Service 4-7 User Delete All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID User Suspend disable All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID User Resume enable All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID User Assign Role - add memberOf All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ Modification object with GUIDs of assigned roles ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID User Revoke Role - delete memberOf All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ Modification object with GUIDs of assigned roles ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID Role Add Third party requests only. No callbacks when a role is created using the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ PSO with created attributes and values ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID Role Modify All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ Modification object with modified attributes and values ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID Table 4–3 Cont. Callback Initiated Events Entity Operation Event Initiator Returned in Post-Processing Handler Returned in Status Change Plugin Callback 4-8 Oracle Fusion Middleware Developers Guide for Oracle Identity Manager

4.4 Configuring the Callback Service

Configuration of the callback service specifies how and when one or more callbacks are invoked. The following sections contain information on the configuration file and the procedure to import this file to the Metadata Services repository. ■ Understanding CallbackConfiguration.xml ■ Importing CallbackConfiguration.xml

4.4.1 Understanding CallbackConfiguration.xml

The configuration is stored in a single file called CallbackConfiguration.xml. This configuration file is located in the Oracle Identity Manager meta directory repository. It is used by the default event handlers and validation plug-in. The following parameters are configurable: ■ Policy name: Defines the name of the callback policy. The value comes from the provisioning request. This is unique to Oracle Identity Manager and takes a string value. ■ Entity type: Refers to the entity type for which the callback policy is applicable. It is a required, single value. Possible values are User, Role, and RoleUser. ■ Operation: Refers to the database operations for which the callback policy is applicable. The required value may be either Create or Delete. ■ Description: Takes a localized string that is a description of the policy. ■ ConstraintAttribute and ConstraintAttributeValue: Fields specify a simple constraint that allows handlers and plug-in code to decide whether to invoke the particular callback for the given object. The attribute will be searched for in the entity data available to the handler, either in the form of orchestration data or RequestData. If the data does not exist, the constraint will not apply. – ConstraintAttribute: Takes as a value the name of an attribute on which the constraint is specified. The name must be the attribute name as defined on the application side as opposed to the name defined on the Oracle Identity Manager side. See Mapping Oracle Identity Manager Attributes on page 4-4 for more information. – ConstraintAttributeValue: Takes a value equal to the value the ConstraintAttribute must have. The value here must be the same as the value of the ConstraintAttribute present in the orchestration or request data. If the data has multiple values, at least one must match. This parameter is relevant only when ConstraintAttribute itself has a value. ■ Provisioning Steps: Specifies the orchestration step for which this callback policy should be used. Possible values are: Role Delete All sources: third party requests, the console and through a reconciliation event. ■ Target Type ■ Target GUID ■ Operation ■ Request ID ■ OIM Request Status ■ Target Type ■ Target GUID ■ Operation ■ Request ID Table 4–3 Cont. Callback Initiated Events Entity Operation Event Initiator Returned in Post-Processing Handler Returned in Status Change Plugin Callback Using the Callback Service 4-9 – validation – preProcessing – approval – postProcessing – completion ■ stepName: Refers to a Web service endpoint for the external application. ■ description: Takes a localized string that is a description of the Web service endpoint. ■ InvokeOnChange: Takes as a value one or more attribute names and is applicable only to modify operations. The callback will be invoked only when one of the attributes listed as a value of this parameter has changed. The value must be the attribute name as defined on the application side as opposed to the name defined on the Oracle Identity Manager side. See Mapping Oracle Identity Manager Attributes on page 4-4 for more information. ■ CallbackOnly: Specifies whether Oracle Identity Manager should wait for a response from the external application. Possible values are true or false. If true, then Oracle Identity Manager will wait for a response from the application and, until a response is received, the orchestration process will be waiting. If false, then Oracle Identity Manager will not wait for a callback response and the orchestration process will continue. ■ targetIDAttribute: Takes as a value an attribute that should be used as the target GUID in the message. The value must be the attribute name as defined on the application side as opposed to the name defined on the Oracle Identity Manager side. See Mapping Oracle Identity Manager Attributes on page 4-4 for more information. The default value is LDAP GUID. ■ roleIDAttribute: Takes as a value the role attribute that should be used as role GUID in the message. The value must be the attribute name as defined on the application side as opposed to the name defined on the Oracle Identity Manager side. See Mapping Oracle Identity Manager Attributes on page 4-4 for more information. The default value is LDAP GUID. Example 4–1 is a sample configuration file. Example 4–1 Sample CallbackConfiguration.xml ?xml version=1.0 encoding=UTF-8? callbackConfiguration xmlns=http:www.oracle.comschemaoimcallback_config xmlns:xsi=http:www.w3.org2001XMLSchema-instance xsi:schemaLocation=http:www.oracle.comschemaoimcallback_config policy policyNameUser Creation1policyName entityTypeUserentityType operationCreateoperation descriptionPolicy to create a user in the storedescription provisioningSteps postProcessing asyncSteps stepNamehttp:adc2120179.us.oracle.com:7001testCallbackService PostProcessingPluginRequestPortImplTeststepName descriptionWebservice url for this policydescription asyncSteps postProcessing provisioningSteps