Deleting a User

Function

This API is used to delete a user.

Note

This operation will invalidate your existing token. After the operation is complete, obtain a new token.

URI

  • URI format

    DELETE /v3/users/{user_id}

  • URI parameters

    Parameter

    Mandatory

    Type

    Description

    user_id

    Yes

    String

    User ID.

Request Parameters

  • Parameters in the request header

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token with the Security Administrator permission.

  • Example request

    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X DELETE https://sample.domain.com/v3/users/2c1c6c54e59141b889c99e6fada5f19f
    

Response Parameters

None

Status Codes

Status Code

Description

204

The user is deleted successfully.

400

The server failed to process the request.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.

405

The method specified in the request is not allowed for the requested resource.

413

The request entity is too large.

500

Internal server error.

503

Service unavailable.