Active Roles 7.2 - SPML Provider Administrator Guide

This example illustrates how to obtain a list of the child objects (direct descendants) of the Active Directory container object. In proxy mode, you can use this example to list the domains that are registered with Active Roles (managed domains).

To do this, SPML Provider performs the search operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <searchRequest> element asks SPML Provider to perform a search and return the identifiers of the objects found.
• The <query> element determines that SPML Provider is to perform a one-level search (that is, to search only direct descendants of the object specified by <basePsoID>).
• The <basePsoID> element specifies the distinguished name of the container object to search.

The response contains the identifiers (distinguished names) of the objects residing in the container object specified by the <basePsoID> element.

This example illustrates how to obtain a list of objects that reside below the Active Directory object in the directory tree. You can use this example to list the objects that reside in a given domain.

To do this, SPML Provider performs the search operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <searchRequest> element asks SPML Provider to perform a search and return the identifiers of the objects found.
• The <query> element determines that SPML Provider is to perform a subtree search (that is, to search any direct or indirect descendant of the object specified by <basePsoID>).
• The <basePsoID> element specifies the distinguished name of the container object to search. For instance, this could be the distinguished name of a domain that is registered with Active Roles (managed domain).

The response contains the identifiers (distinguished names) of the objects that reside in the directory tree below the container object specified by the <basePsoID> element.

This example illustrates how to obtain an XML representation of the specific object.

To do this, SPML Provider performs the search operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <searchRequest> element asks SPML Provider to perform a search and return the XML representation of the object found.
• The <query> element determines that SPML Provider is to perform a base search (that is, to search only the object identified by <basePsoID>).
• The <basePsoID> element specifies the distinguished name of the object to search. For instance, this could be the distinguished name of a user account.

The response contains the identifier of the object and the XML representation of the object (as defined in the schema of the target).

This example illustrates how to obtain the next set of objects from the result set that SPML Provider selected for a search operation.

In this case, SPML Provider performs the iterate operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <iterateRequest> element asks SPML Provider to return additional objects that matched a previous search request but that the Provider has not yet returned to the client.
• The <iterator> element supplies the iterator ID found either in the original search response or in a subsequent iterate response.

This example illustrates how to tell SPML Provider that the client has no further need for the search results that a specific iterator represents.

In this case, SPML Provider performs the closeIterator operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <closeIteratorRequest> element tells SPML Provider that the client no longer intends to iterate search results.
• The <iterator> element specifies the ID of the iterator to close. This could be the iterator ID found in the original search response or in a subsequent iterate response.

This example illustrates how to get a list of inactive (disabled or deprovisioned) user accounts found within a specified container.

To do this, SPML Provider performs the search operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <searchRequest> element asks SPML Provider to perform a search and return the identifiers of the objects found.
• The <query> element determines SPML Provider is to perform a subtree search.
• The <basePsoID> element specifies the distinguished name of the container object to search. For instance, this could be the distinguished name of a certain organizational unit.
• The <filter> element encloses the elements that direct SPML Provider to search for inactive user accounts. Thus, the <equalityMatch> elements are configured so as to limit the search to user accounts; the <isActive> element combined with the <not> element causes SPML Provider to select the user accounts that are inactive.
• The response contains the identifiers (distinguished names) of the inactive user accounts that exist in the directory tree below the container object specified by the <basePsoID> element.

This example illustrates how to have SPML Provider find all objects that meet certain search criteria and return the values of certain attributes of the objects found.

In this case, SPML Provider performs the search operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <searchRequest> element asks SPML Provider to perform a search and return the identifiers and attribute values of the objects found.
• The <query> element determines the scope of the search.
• The <basePsoID> element specifies the distinguished name of the container object to search. For instance, this could be the distinguished name of a certain organizational unit.
• The <filter> element encloses the elements that specify the search criteria.
• The <attributes> element specifies the object attributes to be included in the response.

The response contains the identifiers (distinguished names) of the objects found and, for each object, the values of the attributes specified by the <attributes> element in the search request.

This example illustrates how to set a new password for the specific user account.

To set a new password, SPML Provider performs the setPassword operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <setPasswordRequest> element asks SPML Provider to change to a specified value the password that is associated with a certain user account.
• The <psoID> element specifies the distinguished name of the user account.
• The <password> element specifies the new password to assign to the user account.

This example illustrates how to either disable or deprovision a specified user account, depending on the SPML Provider configuration (see the description of the <suspendAction> element in the “Configuring SPML Provider” section earlier in this document).

To do this, SPML Provider performs the suspend operation.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <suspendRequest> element asks SPML Provider to perform the suspend action on a certain user account (either disable or deprovision, depending on the configuration of SPML Provider).
• The <psoID> element specifies the distinguished name of the user account to suspend.

This example illustrates how to enable a disabled user account. This operation requires that the suspend action be set to disable in the SPML Provider configuration file (see the description of the <suspendAction> element in the “Configuring SPML Provider” section earlier in this document).

In this case, SPML Provider performs the resume operation in order to enable a disabled user account.

The request message includes the following XML elements:

• The <soap:Envelope> and <soap:Body> SOAP elements enclose the SPML payload.
• The <resumeRequest> element asks SPML Provider to re-enable a user account that has been disabled.
• The <psoID> element specifies the distinguished name of the user account to re-enable.