Searching Users by Using Pagination

RiskMinder Web Services Developer's Guide › Managing Users and Accounts › Performing User Operations › Searching Users by Using Pagination

Searching Users by Using Pagination

When you search for users in the RiskMinder database or directory service, the information is fetched and displayed in the alphabetical order of the user names. If you have a large setup with many users, then you will have to navigate through the search result to search for a particular user. To increase the search efficiency in such cases, you can search the users by specifying the start and end index range.

Note: If you are searching for the users in the LDAP organization, then ensure that the LDAP supports pagination search.

This section walks you through the following steps for searching the active users based on the search index:

Preparing the Request Message
Invoking the Web Service
Interpreting the Response Message

Preparing the Request Message

The following table lists the elements of the listUsersRequest message.

Element	Mandatory	Description
orgName	No	The name of the organization to which the user belongs. Note: If the organization name is not passed, then the Default Organization is used for the operation.
startIndex	Yes	The index entry starting from which the user information has to be fetched. For example, if the complete search fetches 60 results and if the startIndex is set to 45, then the user information from search result entry 45 is returned.
endIndex	Yes	The index page where the user search must end. For example, if the complete search fetches 60 results and if the startIndex is set to 45 and endIndex is set to 55, then the user information from the search result entry 45 to 55 is returned.
clientTxId	No	The unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To search for users based on pagination:

(Optional) Include the authentication and authorization details in the header of the listUsers operation. See "Managing Web Services Security" for more information on the header elements.
Use the listUsersRequest elements to collect the start and end index, as listed in the table.
Use the listUsersRequest message and construct the input message by using the details specified in the preceding step.
Invoke the listUsers operation of the ArcorUserRegistrySvc service to fetch the user details for the specified start and end index.
This operation returns the listUsersResponse message that includes the transaction identifier, authentication token, and user details. See the following section for more information on the response message.

Interpreting the Response Message

The response message, listUsersResponse, returns the transaction identifier and authentication token in the SOAP envelope header. The SOAP body includes the user details and status for a successful transaction and the Fault response for an error condition.

See the following table for more information on the elements returned for a successful transaction. Refer to appendix, "Exceptions and Error Codes" if there are any errors.

Element	Description

Header Elements
udsTransactionID	The unique identifier of the transaction performed by using UDS.
authToken	The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service. By default, the authentication token is valid for one day, after which you need to authenticate again.
Body Elements
count	The total number of users returned in the search result.
userId/orgName	The name of the organization to which the user belongs.
userId/userName	The unique identifier with which the user is identified in the system.
userId/userRefId	The identifier used as a reference to track different operations performed by a user.
dateCreated	The timestamp when the user was created in the system.
dateModified	The timestamp when the user details were last modified.
emailId	The email ID of the user that has been registered. If multiple email IDs are configured for the user, then all email IDs are fetched.
telephoneNumber	The telephone number of the user that has been registered. If multiple telephone numbers are configured for the user, then all numbers are fetched.
firstName	The first name of the user.
middleName	The middle name of the user.
lastName	The last name of the user.
pam	The Personal Assurance Message (PAM) displayed to the user when they try to access a resource protected by RiskMinder.
pamImageURL	The URL which contains the image displayed to the user, when they try to access a resource protected by RiskMinder.
image	The picture that the user wants to upload to identify themselves.
status	The status of the user: INITIAL ACTIVE INACTIVE DELETED
customAttribute	The additional user information that you want to pass as a name-value pair. name Indicates the name of the attribute that you want to create. value Indicates the corresponding value for the name.
startLockTime	The timestamp when the user has to be deactivated.
endLockTime	The timestamp when the deactivated user has to be activated.