アカウントからユーザーを削除します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。
削除 https://{{host}}/api/public/users
注意:この機能は、プラットフォームのバージョン7.1で導入されました。
クエリパラメータ
パラメータ | 説明 |
---|---|
ホスト | 環境URL(例: https://bots.kore.ai) |
本文パラメータ
パラメータ | 説明 |
---|---|
deleteEmailIdsまたはorgUserIds | 情報が削除される各ユーザーのメールアドレスまたは組織のユーザーIDの配列 |
認証
以下の構文を使用して、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" } } ] }