Previous Topic: Fetching the Personal Assurance MessageNext Topic: Authenticating LDAP Users

CA AuthMinder Web Services Guide › Managing Users and Accounts › Setting Custom User Attributes

Setting Custom User Attributes

In addition to the standard user information that AuthMinder supports, you can set additional user information by using custom attributes. You must pass the additional information as name-value pairs.

To set the custom user attributes, you must use the setCustomAttributes operation. This section walks you through the following topics for setting custom attributes:

Preparing the Request Message

The following table lists the elements of the setCustomAttributesRequest 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.

customAttribute

No

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.

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 set additional information for an user:

  1. (Optional) Include the authentication and authorization details in the header of the setCustomAttributes operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the setCustomAttributesRequest elements to collect the user information, as listed in the preceding table.
  3. Use the setCustomAttributesRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the setCustomAttributes operation of the ArcotUserRegistrySvc service to set the user information.

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

Interpreting the Response Message

The response message, setCustomAttributesResponse, returns the transaction identifier and authentication token in the SOAP envelope header. These elements are explained in the following table. The SOAP body returns a success message if the operation was performed successfully. If there are any errors, then the Fault response is returned. See appendix, "Error Codes" for more information on the SOAP error messages.

Element

Description

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.