Cloud Administration Mark User Deleted API Cloud Administration Mark User Deleted API
The Cloud Administration Mark User Deleted API can do the following:
Mark an inactive user as pending for future deletion. The marked user will be deleted from the Cloud Authentication Service when automatic bulk deletion has taken place.
- Undelete a user if marking the user for deletion was a mistake.
Users marked as deleted are removed from the Cloud Authentication Service after seven days. Once deleted, a user can no longer authenticate through the service or register a device. Deletion removes all information and devices associated with the user from the Cloud Authentication Service.
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 APIs .
Administrative RolesAdministrative Roles
This API can use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to mark a user for deletion.
|Method||Request URL||Response Codes|
|200, 400, 403, 404, 409, 500|
Request ParameterRequest Parameter
The Mark Deleted API allows the following parameter.
|Request Parameter||Description||Data Type|
Unique user identifier that is sent in response to the Cloud Administration User Details API .
Request BodyRequest Body
The following table describes the request body.
|Request Body||Description||Data Type|
Must be true or false.
Example Request DataExample Request Data
The following example displays a request.
Authorization: Bearer <JWT token>
Example ResponseExample Response
The following example response shows the deletion status of a single user.
"markDeletedBy": "Some user",
Property Response DescriptionsProperty Response Descriptions
The following table shows property descriptions and data types.
|id||Identifies the user.||String|
|markDeleted||Indicates whether the user is marked for delete.||Boolean|
Date when a user is marked for delete.
|markDeletedBy||Administrator who initiated mark for delete.||String|
Response CodesResponse Codes
The following table shows response codes and descriptions for API.
|200||Successfully marked the user for deletion or cleared marked user for deletion.|
Operation is not performed. One of the following messages is returned:
|403||Not authorized to perform the request.|
|404||User does not exist.|
Operation is not performed because it violates a business rule and returns one of the following messages:
Internal server error occurred when processing the request. The following message is returned:
Unknown error. Mark user for Delete/Undelete returned null response from Cloud Authentication Service. Or an unexpected error occurred.