Fetching User Attributes Configured for Encryption

CA AuthMinder Web Services Guide › Configuration Management Web Service › Fetching User Attributes Configured for Encryption

Fetching User Attributes Configured for Encryption

The administrators of an organization can choose to store the user attributes in an encrypted format. To fetch such attributes that are configured to be stored in encrypted format, you need to use the listConfiguredAttributesForEncryption operation.

This section walks you through the following topics for fetching the user attributes that are configured for encryption:

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

Preparing the Request Message

The listConfiguredAttributesForEncryptionRequest message is used to fetch the user attributes that are configured for encryption. The following table lists the elements of this request message:

Element	Mandatory	Description
orgName	No	The name of the organization for which the user attributes have to be fetched.
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 user attributes configured for encryption:

(Optional) Include the authentication and authorization details in the header of the listConfiguredAttributesForEncryption operation. See chapter, "Managing Web Services Security" for more information on the header elements.
Use the listConfiguredAttributesForEncryptionRequest elements to get the organization name.
Use the listConfiguredAttributesForEncryptionRequest message and construct the input message by using the details obtained in preceding step.
Invoke the listConfiguredAttributesForEncryption operation of the ArcotConfigRegistrySvc service to fetch the user attributes.
This operation returns the listConfiguredAttributesForEncryptionResponse 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, listConfiguredAttributesForEncryptionResponse, returns the transaction identifier and authentication token in the SOAP envelope header. The SOAP body includes the user attributes configured for encryption 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
isGlobal	Specifies whether the user attributes are configured for encryption at the global level. Possible values are: True: Indicates that the user attributes are configured for encryption at the global level. False: Indicates that the user attributes are configured for encryption at the organization level.
attribute	The name of the user attribute that is configured for encryption.