Previous Topic: Searching OrganizationsNext Topic: Fetching Directory Service Attributes


Fetching AuthMinder Database Attributes

The listArcotAttributes operation is used to fetch the user attributes that are used to store the user information in the AuthMinder database.

This section walks you through the following topics for fetching user attributes supported by AuthMinder database:

Preparing the Request Message

The listArcotAttributesRequest message is used to fetch the user attributes. The following table lists the elements of this request message:

Element

Mandatory

Description

clientTxId

No

Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To fetch the AuthMinder database attributes:

  1. (Optional) Include the authentication and authorization details in the header of the listArcotAttributes operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the listArcotAttributesRequest elements to fetch the user attributes.
  3. Use listArcotAttributesRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the listArcotAttributes operation of the ArcorUserRegistryMgmtSvc service to fetch the user attributes supported by AuthMinder database.

    This operation returns the listArcotAttributesResponse message that includes the transaction identifier, authentication token, and user attributes. See the following section for more information on the response message.

Interpreting the Response Message

The response message, listArcotAttributesResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the AuthMinder attributes for a successful transaction and the fault response for an error condition.

The following table provides more information about 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

DATECREATED

The timestamp when the user account was created.

DATEMODIFIED

The timestamp when the user account was last modified.

EMAILADDR

The email address of the user.

FNAME

The first name of the user.

IMAGE

The personal assurance image that the user selected.

LNAME

The last name of the user.

MNAME

The middle name of the user.

PAM

The Personal Assurance Message (PAM) that is displayed when the user tries to access any AuthMinder-protected resource.

PAM is the text string that serves as server verification to the client and is set by the user during enrollment.

PAMURL

The URL that lists the images, which can be used by the user to select their personal assurance image.

STATUS

The status of the user in the database. Following are the supported values:

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

TELEPHONENUMBER

The telephone number of the user.

USERID

The unique identifier for the user.