Previous Topic: Updating the User StatusNext Topic: Performing User Account Operations

RiskMinder Web Services Developer's Guide › Managing Users and Accounts › Performing User Operations › Deleting Users

Deleting Users

This section walks you through the following steps for deleting users:

Preparing the Request Message

The deleteUserRequest message is used to delete users in the RiskMinder database. The following table lists the elements of this request 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 unique identifier assigned to the user when they are created. This identifier is used as a reference to track different operations performed by a user.

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 delete users in the RiskMinder database:

  1. (Optional) Include the authentication and authorization details in the header of the deleteUser operation. See "Managing Web Services Security" for more information on the header elements.
  2. Use the deleteUserRequest elements to provide the user information, as listed in the table.
  3. Use the deleteUserRequest message and construct the input message by using the details specified in the preceding step.
  4. Invoke the deleteUser operation of the ArcorUserRegistrySvc service to delete users.

    This operation returns the deleteUserResponse 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, deleteUserResponse, 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.