Delete user

The endpoint provides functionality to delete a user.

HTTP request

DELETE https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
userId	path	string	required	The ID of the user

Example request

Set the ID of the user.

userId=your-user-id-123

curl --request DELETE "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId" \
  --header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 204 is returned if the user is successfully deleted.

On missing user

HTTP/1.1 404 is returned if no user is found with the given userId, with a detailed message.

Example response

note

The referred extId field in the response equals the userId.

{
    "errors": [
        {
            "code": "errors.noRecord",
            "message": "A user with extId 4a5e7346-488b-46f9-914f-79ddb1131e0ba doesn't exist on client with name Client-users"
        }
    ]
}

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 500 is returned if an unexpected error occurs.