SetPassword in ADS

Sets the password in an ADS connected system

A set-password workflow propagates a password from DirX Identity to the accounts of one connected system. It is triggered when a user or an administrator changes a password in the Identity Store, or when the password synchronization workflows distribute a password change. The workflow reads the password over the setPassword channel of the Identity Store port and writes it through the target system port; it does not synchronize any other account attribute.

Because a set-password workflow carries credentials, its ports decrypt the password attribute explicitly through the decrypt.attribute parameter, and failures are reported by a dedicated password notification connector instead of the regular notification connector.

SetPassword in ADS is the dedicated password workflow for connected systems of type ADS. You use it when DirX Identity sends a password request that must update the target-side password without running the full provisioning workflow for the rest of the object.

The workflow keeps password handling separate by using the SetPassword activity, the setPassword channel on TS and the workflow parameter topicprefix with the default value dxm.setPasswordRequest.. It still reads the account context from the Identity Store before it writes the new password to the connected directory.

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

SetPassword in ADS

Category

Target Realtime / ADS

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

ADS

Configuration wizard

wf-Provisioning-SetPassword.xml

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/ADS/SetPassword in ADS

Prerequisites

  • You configure a connected directory of type ADS that uses the AdsConnector and the bind profile ADSadmin.

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

  • Because the TS port uses SSL, the connected directory accepts that connection and the Java-based Server trusts the certificate that it presents.

  • You route password requests to the workflow topic prefix dxm.setPasswordRequest..

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

SetPassword

ProvisionTS

provisioningActivity

setPassword activitity to update passwords in an ADS target system

IdentityDomain, notify, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

SetPassword

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

SetPassword

notify

notificationPort

NotifyMailPwdConnector

-

-

not set

SetPassword

TS

provisioningPort

AdsConnector

ADS

ADSadmin

TRUE

Channels

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

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for account - group memberships

OneToOne

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

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for account - group memberships

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 SetPassword in ADS
Parameter Default value

timeout

P0Y0M4DT0H0M0S

topicprefix

dxm.setPasswordRequest.

tscluster

forest

tsresource

domain
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 SetPassword
Parameter Default value

resourcefamily

ADS

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port IdentityDomain (activity SetPassword)
Parameter Default value

decrypt.attribute

userPassword
Table 8. Parameters of port notify (activity SetPassword)
Parameter Default value

decrypt.attribute

userPassword
Table 9. Parameters of port TS (activity SetPassword)
Parameter Default value

decrypt.attribute

unicodePwd

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 SetPassword activity reads the affected account from IdentityDomain and writes the new password to TS over setPassword. The notify port uses NotifyMailPwdConnector, so password runs can send the password-specific notification path. The CryptFilter decrypts unicodePwd before the AdsConnector updates the connected directory.

If processing fails, SetPassword 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 error notification through Message. The workflow-level timeout keeps the request for up to four days.

Operation

  1. You send a password request that matches the workflow topic prefix dxm.setPasswordRequest..

  2. You let the Java-based Server route the request to SetPassword.

  3. You let IdentityDomain read the affected account context.

  4. You let TS write the new password to the connected directory over setPassword.

  5. You let notify send the configured password notification and write the result back to the Identity Store.

  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.