Previous Topic: Example of an Extended Request

Next Topic: Modify Request

Extended Request Types

Request Type

Function

Account-CheckSync

Check an account against its assigned policies for out-of-sync attributes.

Account-ForcedDelete

Delete this account and clear all references to it.

Account-Relocate

Move the selected account to the correct container as specified by a given policy.

Account-SyncWithPolicies

Synchronize an account with its assigned policies.

Container-CheckAccountSync

Check whether the accounts in a container need to be synchronized with associated policies.

Container-Correlate

Perform a correlation on an endpoint or on a container of a hierarchical endpoint.

Scope
The search scope. ONELEVEL_SCOPE is represented by the integer 1 and SUBTREE_SCOPE is represented by the integer 2.

ONELEVEL_SCOPE
Correlates one level the managed accounts on an end point system with the Global Users.

SUBTREE_SCOPE
Correlates all managed accounts on an end point system with Global Users.

CreateUserAsNeeded
Use “true” to create Global Users as needed.

Container-Explore

Perform an explore operation on an endpoint or a container of a hierarchical endpoint.

Scope
The search scope. ONELEVEL_SCOPE is represented by the integer 1 and SUBTREE_SCOPE is represented by the integer 2.

ONELEVEL_SCOPE
Searches one level for managed objects on the given Container.

SUBTREE_SCOPE
Searches for all managed objects on the given Container.

Container-SyncAccountsWithPolicies

Synchronize the accounts in a container with their assigned policies.

Container-UpdateUserFields

Update the global users' attributes with their correlated accounts' attributes, according to the attribute mappings defined in the defaultUserUpdateMap field of the container object.

Scope
The search scope. ONELEVEL_SCOPE is represented by the integer 1 and SUBTREE_SCOPE is represented by the integer 2.

ONELEVEL_SCOPE
Performs the updateUserFields operation for the accounts directly below the given container.

SUBTREE_SCOPE
Performs the updateUserFields operation for all accounts of the given container.

EndPoint-IncludeContainer

Bring a top-level container into the database (but not its contents). This is required for the exploration operation to work on some hierarchical endpoints such as ADS endpoints where the normal ONELEVEL exploration does not add the top-level container to the provisioning direcotry. This is also useful to manage only a portion of the hierarchical endpoint with the Provisioning Server while the remaining portion is completely hidden to Provisioning Server users.

ContainerName
The name of the container to include.

ContainerType
Option-specific types of containers. See the JIAM OptionDescriptor Javadoc for available container types for each option

Group-ListMembers

Search for Global Users that are members of this Group.

Scope
The search scope. ONELEVEL_SCOPE is represented by the integer 1 and SUBTREE_SCOPE is represented by the integer 2.

ONELEVEL_SCOPE
Searches one level for group members.

SUBTREE_SCOPE
Searches recursively through all nested child groups for members.

UserNameMatchString
The string to match the user name against. Use null to return all the users of this group.

CountLim
The maximum number of users to return. If 0, return all entries that satisfy the above matching expression.

Policy-CheckAccountSync

Check the accounts against a given policy.

Policy-ForcedDelete

Delete this policy and clear all references to it.

Policy-RelocateAccounts

Move the accounts associated with a policy to the correct containers.

Policy-SyncAccounts

Synchronize the accounts associated with a policy.

Role-CheckAccountSync

Check whether the accounts of multiple users need to be synchronized against the policies assigned to this role.

Role-CheckUserSync

Check whether the users of a role need to be synchronized with their associated policies.

Role-DeleteWithPolicies

Delete the role and all associated policies.

ForcedDelete
Set to true to delete the role and clear all references to it as well as associated Policies.

 

Role-ForcedDelete

Delete this role and clear all references to it.

Role-SyncAccountsWithPolicies

Synchronize the accounts of multiple users against the policies assigned to a role.

Role-SyncUsers

Synchronize the users of a role with all assigned policies.

User-CheckAccountSync

Check whether the accounts of a user need to be synchronized with associated policies.

User-CheckSync

Check whether the user requires synchronization with associated Roles.

User-DeleteWithAccounts

Delete the user and all associated accounts.

ForcedDelete
Set to true to delete the user and clear all references to it as well as associated accounts.

User-ForcedDelete

Delete this user and clear all references to it.

User-GeneratePassword

Generate a random password that conforms to the password quality rules for a global user.

User-RequestPasswordReset

Register a user's password reset request.

User-SyncAccountsWithPolicies

Synchronize the accounts of a user with their assigned policies.

User-SyncWithRolesAddAccounts

Synchronize a user with roles and create accounts.

User-SyncWithRolesDeleteAccounts

Synchronize a user with roles and delete accounts.