SetPassword in Google Apps

Sets the password in a Google Apps directory.

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 Google Apps sends password changes from the Identity Store to a connected directory of type Google Apps. You use it when the account already exists in the target system and you only want to update the target-side password instead of running a full provisioning cycle.

The workflow stays in the same Google Apps target-system model as the related provisioning workflows, identified by tsresource google-domain and tscluster google-cluster. It keeps accounts, groups, and members available for object resolution while the target side uses setPassword for the actual password update.

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 Google Apps

Category

Target Realtime / Google Apps

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

Google Apps

Configuration wizard

wf-Provisioning-SetPassword.xml

Active in the factory data

FALSE

Factory data version

8.4

Factory data path

Workflows/Default/Target Realtime/Google Apps/SetPassword in Google Apps

Prerequisites

  • Create a connected directory of type Google Apps with the bind profile AppsAdmin.

  • Link that connected directory to a target system of type Google Apps in the Identity Store.

  • Make sure the Java-based Server can reach the Identity Store through Domain_Admin and the connected directory through GoogleAppsConnector.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

SetPassword

ProvisionTS

provisioningActivity

setPassword activitity to update passwords in a Google Apps 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

GoogleAppsConnector

Google Apps

AppsAdmin

not set

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 members

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

timeout

P0Y0M4DT0H0M0S

topicprefix

dxm.setPasswordRequest.

tscluster

google-cluster

tsresource

google-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

Google_Apps

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

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 SetPassword activity reads the account context from IdentityDomain and sends the password update to TS. The workflow keeps accounts, groups, and members available while GoogleAppsConnector uses the target-side setPassword channel for the actual password change.

If the run finishes with a password notification, the workflow uses notify through NotifyMailPwdConnector. If the update fails, the workflow switches to error and sends the failure information through Message.

Operation

  1. You start the workflow for a password change that belongs to a Google Apps account in the target system.

  2. SetPassword reads the required object context from IdentityDomain.

  3. CryptFilter decrypts the target-side password value on TS, and GoogleAppsConnector writes the change through setPassword.

  4. The workflow can send the password notification through notify.

  5. If the target update fails, the workflow switches to error and sends the failure information through Message.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario before you enable it.