Updating User Status
The updateUserStatus operation is used to change the status of the user. In a single call, you can update the status of multiple users.
aa821test
2112859
The updateUserStatus operation is used to change the status of the user. In a single call, you can update the status of multiple users.
The status of a user can be any of the following:
- INITIAL
- ACTIVE
- INACTIVE
- DELETED
This section walks you through the following topics for changing 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 to. 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. |
Note: If want to update the status of more than one user, then repeat the userID element with the user details. | ||
status | Yes | The status that you want to assign to the user. Following are the supported values: INITIAL ACTIVE INACTIVE DELETED |
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 user status in the CA Strong Authentication database:
- (Optional) Include the authentication and authorization details in the header of the updateUserStatus operation. See the section, "Manage Web Services Security" for more information on the header elements.
- Use the updateUserStatusRequest elements to update the user status.
- 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 update 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 the section, "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. |