Setting Custom User Attributes

RiskMinder Web Services Developer's Guide › Managing Users and Accounts › Setting Custom User Attributes

Setting Custom User Attributes

In addition to the standard user information that RiskMinder 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 steps for setting custom attributes:

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

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 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 your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To set additional information for a user:

(Optional) Include the authentication and authorization details in the header of the setCustomAttributes operation. See "Managing Web Services Security" for more information on the header elements.
Use the setCustomAttributesRequest elements to collect the user information, as listed in the table.
Use the setCustomAttributesRequest message and construct the input message by using the details specified in the preceding step.
Invoke the setCustomAttributes operation of the ArcorUserRegistrySvc 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 the 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, "Exceptions and Error Codes" for more information on the SOAP error messages.

Element	Description
udsTransactionID	The unique identifier of the transaction performed by using UDS.
authToken	The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service. By default, the authentication token is valid for one day, after which you need to authenticate again.

Element

Description

udsTransactionID

The unique identifier of the transaction performed by using UDS.

authToken

The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service.

By default, the authentication token is valid for one day, after which you need to authenticate again.