Ident_EntraID_Realtime

Sample workflow to provision an Entra ID directory from a DirX Identity target system.

A provisioning workflow transfers the account, group and membership changes that DirX Identity has calculated for a target system into the connected system, and acknowledges the result back into the Identity Store. It is the workflow that executes what privilege resolution has decided: when a user gains or loses a privilege, the resolution writes the resulting account or membership change into the target system subtree of the Identity Store, and this workflow applies that change to the connected system.

The workflow processes single requests as they arrive, so it reflects changes with little delay. Use the corresponding validation workflow to detect changes that were made in the connected system outside of DirX Identity.

Ident_EntraID_Realtime is the provisioning workflow for connected systems of type EntraID. It provisions more than basic accounts and groups: the workflow also carries memberships, owner assignments, service plans, roles and password changes between the Identity Store and the connected directory.

Because tscluster and tsresource are both *, the factory data does not bind the workflow to one fixed target system resource. The owner channel is present on both sides of the mapping, while TS also adds setPassword for password handling.

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

Ident_EntraID_Realtime

Category

Target Realtime / EntraID

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

EntraID

Configuration wizard

wf-Provisioning-Synchronize.xml

Active in the factory data

FALSE

Factory data version

9.0

Factory data path

Workflows/Default/Target Realtime/EntraID/Ident_EntraID_Realtime

Prerequisites

  • You configure a connected directory of type EntraID that uses EntraIDConnector and the bind profile Application.

  • You make the Identity Store available through the bind profile Domain_Admin and the EntraID connected directory available through the TS port of the Java-based Server.

  • You already have the relevant EntraID target system subtree in the Identity Store, so the workflow can read the current source state over accounts, groups, members, owner, plans and roles.

  • If you use the event port, you provide the JMS environment that matches jmsprovidertype = MQSERIES.

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

EntraIDConnector

EntraID

Application

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

owner

Channel for owner accounts. This channel is for initial import accounts and then use identifier DN to add/remove as owner to/from group.

OneToOne

SearchAttributes

plans

Channel for service plans

OneToOne

SearchAttributes

roles

Channel for roles

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

owner

This Channel for owner accounts serves as dummy for corresponding channel on Idenity Store side. Do not change Export Sequence No: 0.

OneToOne

SearchAttributes

plans

Channel for service plans

OneToOne

SearchAttributes

roles

Channel for roles

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 Ident_EntraID_Realtime
Parameter Default value

dxminitialload

FALSE

timeout

P0Y0M4DT0H0M0S

tscluster

*

tsresource

*
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

EntraID

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

userPassword
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

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 reads the requested state from IdentityDomain and writes the corresponding state to TS. It uses the shared channels accounts, groups, members, owner, plans and roles, and it uses the additional setPassword channel on TS when the request includes password data. The CryptFilter decrypts password before EntraIDConnector receives the request.

If processing fails, join retries the request three times and waits 30 minutes between attempts. If the request still fails, the workflow passes it to error, which sends the notification through Message. The workflow-level timeout keeps the request for up to four days.

Operation

  1. You trigger a provisioning request for an accounts, groups, members, owner, plans or roles object in the EntraID target system subtree of the Identity Store.

  2. You let the Java-based Server pass the request to join.

  3. You let IdentityDomain read the affected state over the matching channel.

  4. You let TS apply the change in the connected directory and use setPassword if the request contains password data.

  5. You let the workflow write the result back to the Identity Store, publish the provisioning event through event and send the configured notification through notify.

  6. If the request still fails after the configured retries, you let error report the failure through Message.

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.