Cloud Administration Delete User Now API
8 months ago

Cloud Administration Delete User Now API

This API deletes a single disabled user from the Cloud Access Service (CAS) and immediately removes all information and devices associated with the user. For more information on how this operation is performed from the Cloud Administration Console, see Delete a Single User Immediately from the Cloud Access Service.

Note:   This operation cannot be undone. You can re-add the user by resynchronizing.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following method, request URL, response body type, and response codes to delete a disabled user.

MethodRequest URLResponse Body TypeResponse Codes
DELETE AdminInterface/restapi/v1/users/<userID>application/json 200, 403, 404, 405, 409, 429, 500

Request Parameters

This API requires the following request parameter.

Request ParameterDescription
<userID>User identifier.

Request Example

The following example displays a request to delete a user immediately.

DELETE https://localhost/AdminInterface/restapi/v1/users/eb2e12ae-1112-451b-98e1-dfe4e6afd60d

Content-Type: application/json

Authorization: Bearer <JWT token>

Response Codes

Response CodeDescription
200Successfully deleted the disabled user.
403Not authorized to perform the request.
404User is not found.
405Method Not Allowed. The method you are using is not allowed for users in the SCIM Managed and Azure Active Directory (SCIM) identity sources.
409

The operation is not performed for one of the following reasons:

  • User is in enabled state.
  • User is in pending deletion state.
429Too many requests.
500Internal error occurred when processing the request.