アカウントからユーザーを削除します。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。

削除 https://{{host}}/api/public/users 注意：この機能は、プラットフォームのバージョン7.1で導入されました。

クエリパラメータ

本文パラメータ

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X DELETE \ https://{{host}}/api/public/users \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "deleteEmailIds"/"orgUserIds":["deskkore1@gmail.com"] }'

サンプル応答

• 成功例：

  {"msg": "Users are removed Successfully"};

• 失敗例：

  { "failedUserDetails": [ { "emailId": "deskkore1@gmail.com", "reason": { "statusCode": 400, "status": 400, "customCode": 400, "errors": [ { "msg": "Unauthorized to perform this activity", "code": 400 } ], "_headers": {}, "message": "Unauthorized to perform this activity", "name": "BadRequest" } } ] }

To remove users from an account.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of User Management under Security & Control.

DELETE https://{{host}}/api/public/users

NOTE: This feature was introduced in ver7.1 of the platform.

Query Parameters

Body Parameters

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X DELETE \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
     "deleteEmailIds"/"orgUserIds":["deskkore1@gmail.com"]
   }'

Sample Response

• For success case:

  {"msg": "Users are removed Successfully"};
  

• Failure case:

      {
      "failedUserDetails": [
          {
              "emailId": "deskkore1@gmail.com",
              "reason": {
                  "statusCode": 400,
                  "status": 400,
                  "customCode": 400,
                  "errors": [
                      {
                          "msg": "Unauthorized to perform this activity",
                          "code": 400
                      }
                  ],
                  "_headers": {},
                  "message": "Unauthorized to perform this activity",
                  "name": "BadRequest"
              }
          }
      ]
  }