User Query Stage

This stage queries the managed user repository for a user, based on the supplied query fields. If the stage identifies a user, it populates the mail, userId, userName, and accountStatus fields in state.

Example configuration

{
    "name" : "userQuery",
    "validQueryFields" : [
        "userName",
        "mail",
        "givenName",
        "sn"
    ],
    "identityIdField" : "_id",
    "identityEmailField" : "mail",
    "identityUsernameField" : "userName",
    "identityServiceUrl" : "managed/user",
    "identityAccountStatusField" : "accountStatus"
},

Dependencies

This stage has no dependencies on preceding or following stages, but cannot be the only stage in a process.

Required Parameters

validQueryFields - an array of fields on which the query can be based.
identityIdField - the managed object property that contains the user ID to be provided to state.
identityEmailField - the managed object property that contains the user mail to be provided to state.
identityUsernameField - the managed object property that contains the username to be provided to state.
identityAccountStatusField - the managed object property that contains the user account status to be provided to state.
identityServiceUrl - the managed object type on which this stage acts.