Validate_SCIMv2_Realtime

Sample workflow to validate a SCIMv2 directory against a DirX Identity target system.

A validation workflow compares the content of the connected system with the state that DirX Identity holds for the corresponding target system. It runs in one of two modes, controlled by the mode parameter of the workflow:

  • InitialLoad - exports all accounts and groups and their relationships from the connected system and imports them into the target system subtree of the Identity Store in replace mode. Use this mode when you take a target system into operation.

  • Validation - detects deviations between the state known in DirX Identity and the state in the connected system, for example accounts or groups that were created or deleted outside of DirX Identity, and writes a message about each deviation into the "to do" field (dxrToDo) of the affected target system object.

Both modes update the dxrTSState attribute and the group member attributes of the affected target system objects.

Validate_SCIMv2_Realtime validates connected systems of type SCIMv2 against the corresponding target system subtree in the Identity Store. In the factory data, dxminitialload is FALSE, so the sample is prepared for regular validation runs after the initial load rather than for loading the service content into DirX Identity.

The workflows in this reference are delivered as factory data and are loaded into the Connectivity configuration database during the initial configuration. They are samples: use the Identity Manager to copy a workflow into your own scenario and adapt the copy. Do not change the delivered objects, because a product update can replace them.

At a Glance

Name

Validate_SCIMv2_Realtime

Category

Target Realtime / SCIMv2

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

SCIMv2

Configuration wizard

wf-Provisioning-Validate.xml

Active in the factory data

FALSE

Factory data version

8.4

Factory data path

Workflows/Default/Target Realtime/SCIMv2/Validate_SCIMv2_Realtime

Prerequisites

  • A connected directory of type SCIMv2 that points to the SCIM service, with the bind profile API Client Authentication set to client credentials that may read the users and groups that you want to validate.

  • A target system of type SCIMv2 in the Identity Store that is linked to that connected directory, and a completed initial load, because the sample is delivered with dxminitialload set to FALSE.

  • The Java-based Server that runs the workflow must be able to reach both the SCIM service and the Identity Store; the Identity Store is accessed through the bind profile Domain_Admin.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

ProvisionTS

provisioningActivity

Join activity for the provision-to-TS workflow

event, IdentityDomain, notify, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

join

event

notificationPort

JmsConnector

-

-

not set

join

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

join

notify

notificationPort

NotifyMailConnector

-

-

not set

join

TS

provisioningPort

SCIMConnector

SCIMv2

API Client Authentication

not set

Channels

Table 1. Channels of port IdentityDomain (activity join)
Channel Description Reference type Delta type

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes
Table 2. Channels of port TS (activity join)
Channel Description Reference type Delta type

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes

setPassword

Channel for setting a password

OneToOne

SearchAttributes

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Validate_SCIMv2_Realtime
Parameter Default value

dxminitialload

FALSE

timeout

P0Y0M4DT0H0M0S
Table 4. Parameters of activity error
Parameter Default value

resourcefamily

Mail

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT2H0M0S
Table 5. Parameters of port Message (activity error)
Parameter Default value

decrypt.attribute

dxmPassword
Table 6. Parameters of activity join
Parameter Default value

resourcefamily

SPMLv1

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port event (activity join)
Parameter Default value

appid

event

decrypt.attribute

userPassword

jmsprovidertype

MQSERIES

tgtisjmsclient

false
Table 8. Parameters of port IdentityDomain (activity join)
Parameter Default value

decrypt.attribute

dxmPassword
Table 9. Parameters of port notify (activity join)
Parameter Default value

decrypt.attribute

userPassword
Table 10. Parameters of port TS (activity join)
Parameter Default value

clientbindprofile-dn

cn=uid-c0a88580-3213a6f6-17491112398—​7e57,dxmC=Bind Profiles,cn=uid-ac1ef574-29f10ee8-173bd2d32a3—​7ff9,dxmC=uid-7f001-11ed166-1015233918c—​7925,dxmC=uid-7f001-54824-101de9c3b73—​7fc0,dxmC=Connected Directories,dxmC=DirXmetahub

decrypt.attribute

password

A Java-based real-time workflow runs as a permanently loaded configuration in the Java-based Server (IdS-J). It is triggered by a request or an event rather than by a schedule. Each workflow consists of activities; an activity opens one port per system it talks to, and each port uses a connector to reach that system.

Most provisioning workflows contain a join activity that performs the actual work and an error activity that receives requests which still fail after all retries and sends a notification about them. The retrylimit, waitbeforeretry and timeout parameters of an activity control how often and how long a failed request is retried before it is handed to the error activity.

The event port publishes change events over JMS, and the notify port sends e-mail notifications. Neither port is bound to a connected directory.

The join activity performs the validation work. Its IdentityDomain port reads the expected state from the Identity Store over the accounts, groups and members channels, and its TS port compares that state with the current content of the SCIM service. The CryptFilter on the TS port decrypts protected attributes before the connector evaluates them.

A request that fails is retried up to three times (retrylimit) with 30 minutes between the attempts (waitbeforeretry). If it still fails, the error activity takes it over and sends a notification through the Message port; the workflow parameter timeout gives a request four days before it is discarded.

Operation

  1. You start a validation run for target system objects of type SCIMv2.

  2. The Java-based Server passes the request to the join activity of this workflow.

  3. The IdentityDomain port reads the relevant accounts, groups and memberships from the Identity Store.

  4. The TS port connects to the SCIM service and compares the current state of those objects with the state stored in DirX Identity.

  5. Deviations are written back into the Identity Store, where DirX Identity updates the validation state and records follow-up work on the affected target system objects.

  6. The event port publishes the validation result as a JMS event; the notify port sends the configured e-mail notifications.

  7. Requests that fail permanently are handed to the error activity, which reports them by e-mail.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario, connect the copy to your connected directory and activate the copy.