To fetch the details of all accounts that are created for a user, you must use the listUserAccounts operation. This section walks you through the following topics for fetching the details of the user accounts.
Note: If you want to fetch details of a particular account, then use the retrieveUserAccount operation. See "Fetch a User Account Details" for more information.
The listUserAccountRequest message elements are same as those for addUserAccountRequest. See Adding User Accounts for more information.
To fetch user accounts:
This operation returns the listUserAccountResponse message that includes the transaction identifier, authentication token, and user account details. See the following section for more information on the response message.
The response message, listUserAccountResponse, 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 "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:
|
|
|
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.
|
|
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|