Fetch a User Account Details

CA Strong Authentication Web Services Guide › Managing Users and Accounts › Performing User Account Operations › Fetch a User Account Details

Fetch a User Account Details

You must use the retrieveUserAccount operation to fetch the details of a particular user account.

This section walks you through the following topics to fetch a single account of a user:

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

Preparing the Request Message

The following table lists the elements of the retrieveUserAccountRequest message:

Element	Mandatory	Description
userId/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.
userId/userName	Yes	The unique identifier with which the user is identified in the system.
userId/userRefId	No	The identifier that is used as a reference to track different operations performed by a user.
account/accountType	Yes	The attribute that qualifies the account ID and provides additional context about the usage of the account ID.
account/accountID	No	The alternate identifier that is used to identify the user in addition to the user name. The account ID is also known as account.
account/accountStatus	No	The status of the account. Following are the supported values: 0-9: Indicates that the account is in the INITIAL state. 10-19: Indicates that the account is in the ACTIVE state. 20-29: Indicates that the account is in the INACTIVE state. 30-39: Indicates that the account is in the DELETED state. >39: Indicates that the account state is UNKNOWN.
account/accountIDAttribute	No	The alternate identifier that is used to identify the user in the system. Note: You cannot pass more than three account ID attributes for a user.
account/dateCreated	No	The timestamp when the account ID was created.
account/dateModified	No	The timestamp when the account ID was last modified.
account/accountCustomAttribute	No	The additional account information that you want to pass as a name-value pair. attributeName Indicates the name of the attribute that you want to create. attributeValue Indicates the corresponding value for the name.
clientTxId	No	The unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To fetch the user account details:

(Optional) Include the authentication and authorization details in the header of the retrieveUserAccount operation. See chapter, "Managing Web Services Security" for more information on the header elements.
Use the retrieveUserAccountRequest elements to collect the user and account details, as listed in the preceding table.
Use the retrieveUserAccountRequest message and construct the input message by using the details obtained in preceding step.
Invoke the retrieveUserAccount operation of the ArcotUserRegistrySvc service to fetch the user details based on the account information.
This operation returns the retrieveUserAccountResponse message that includes the transaction identifier, authentication token, and user account details. See the following section for more information on the response message.

Interpreting the Response Message

The response message, retrieveUserAccountResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the user account details 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. See appendix, "Error Codes" if there are any errors.

Element	Description

Header Elements
udsTransactionID	The unique identifier of the transaction that is performed using UDS.
authToken	The authentication token that is returned if the credential verification to access Web services was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web services. By default, the authentication token is valid for one day, after which you need to authenticate again.
Body Elements
account/accountType	The attribute that qualifies the account ID and provides additional context about the usage of the account ID.
account/accountID	The alternate identifier that is used to identify the user in addition to the user name. The account ID is also known as account.
account/accountStatus	The status of the account. Following are the supported values: 0-9: Indicates that the account is in the INITIAL state. 10-19: Indicates that the account is in the ACTIVE state. 20-29: Indicates that the account is in the INACTIVE state. 30-39: Indicates that the account is in the DELETED state. >39: Indicates that the account state is UNKNOWN.
account/accountIDAttribute	The alternate identifier that is used to identify the user in the system.
account/dateCreated	The timestamp when the account ID was created.
account/dateModified	The timestamp when the account ID was last modified.
account/accountCustomAttribute	The additional account information that you want to pass as a name-value pair. attributeName Indicates the name of the attribute that you want to create. attributeValue Indicates the corresponding value for the name.