Help Center/ Customer Engagement Center/ API Reference/ Other Interfaces Reference/ Deleting Users
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Deleting Users

Scenario

This interface is invoked to delete one or more business users of a tenant.

Method

DELETE

URI

https://Domain name/apiaccess/rest/sum/v1/tenantSpaces/users/{userIds} (For example, the domain name is service.besclouds.com.)

URL Parameters

Table 1 URL parameter

No.

Parameter

Mandatory or Not

Type

Description

1

userIds

Yes

String []

Unique user ID. Use commas (,) to separate multiple IDs.

Request Description

Table 2 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

Yes

App key.

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

3

Content-Type

String

Yes

The value is application/json.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Description

    1

    message

    String

    Description.

    2

    retcode

    String

    Error code. The options are as follows:

    0: success

    Other values: failure

Error Codes

  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 403

    The authentication fails.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Example

Scenario: Delete users.

URL: https://Domain name/apiaccess/rest/sum/v1/tenantSpaces2/users/{userId}

  • Request header
DELETE  /rest/sum/v1/tenants/1532350938331/users/123231  HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
  • Response header
Content-Length: xxx
Content-Type: application/json; charset=UTF-8
  • Response message
{
"message": "",
"retcode": "0",
}