Fetching the Personal Assurance Message

CA AuthMinder Web Services Guide › Managing Users and Accounts › Fetching the Personal Assurance Message

Fetching the Personal Assurance Message

To read the PAM that is set for a user, you must use the getPAM operation. This section walks you through the following topics for fetching the PAM of the users:

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

Preparing the Request Message

The following table lists the elements of the getPAMRequest 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.
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 PAM of a user:

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

Interpreting the Response Message

The response message, getPAMResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the PAM 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
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 that is used as a reference to track different operations performed by a user.
PAM	The Personal Assurance Message (PAM) that is displayed to the user when they try to access a resource protected by AuthMinder.
pamImageURL	The URL which contains the image that is displayed to the user when they try to access a resource protected by AuthMinder.