Updating User Status

CA AuthMinder Web Services Guide › Managing Users and Accounts › Performing User Operations › Updating User Status

Updating User Status

You must use the updateUserStatus operation to change the current status of the user in the database.

This section walks you through the following topics for updating the user status:

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

Preparing the Request Message

The following table lists the elements of the updateUserStatusRequest 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.
status	Yes	The status that you want to assign to the user. Following are the supported values: INITIAL ACTIVE INACTIVE Note: If the current status of the user is DELETED, then you cannot update the status of that user.
startLockTime	No	The timestamp when the user has to be deactivated.
endLockTime	No	The timestamp when the deactivated user has to be activated.
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 update the user status:

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

Interpreting the Response Message

The response message, updateUserStatusResponse 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, "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.

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.