Delete User

Deletes an existing user.

  • Only the Admin of the user’s organization can delete a user.
  • Currently, Admin is a user with the “Identity Admin” role.

URL

https://{{HOST}}/security/user?v={version}userId={userId}

Method

DELETE

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Query Parameters

Name Description Example Type
v
optional		 Version of the api to use /user?v=2.0 number
userId
required		 The ID of the user. /user?userId=testUser string

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token

Example

Request

curl -X DELETE 
  'https://{{HOST}}/securityapi/user?v=2.0userId=tesUser' 
  -H 'Authorization: Bearer {access_token}'

Response

{
  "success": true
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
success Description object definition