Updated on 2024-12-30 GMT+08:00

Deleting a User

Function

This API is used to delete a user.

Constraints

null

URI

DELETE /api/v2/tenant/users/{user_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Delete a specified user based on the transferred user ID.

DELETE https://{domain_name}/api/v2/tenant/users/{user_id}

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

Example Responses

None

Status Codes

Status Code

Description

204

Request successful.

400

Authentication failed.

Error Codes

See Error Codes.