管理者ロールからユーザーまたはグループを追加・削除します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。
ポスト https://{{host}}/api/public/adminroles/assignments/
クエリパラメータ
パラメータ | 必須/任意 | 説明 |
---|---|---|
ホスト | 必須 | 環境URL(例: https://bots.kore.ai) |
本文パラメータ
パラメータ | 必須/任意 | 説明 |
---|---|---|
roleId | 必須 | ユーザーまたはグループに割り当てたり、削除したりするための管理者ロールID |
addUsers or addOrgUserIds | 任意 | 管理者ロールを割り当てるユーザー名または組織ユーザーIDのリスト |
removeUsers or removeOrgUserIds | 任意 | 管理者ロールを削除するユーザー名または組織ユーザーIDのリスト |
addGroups | 任意 | 管理者ロールを割り当てるグループ名のリスト |
removeGroups | 任意 | 管理者ロールを削除するユーザー名のリスト |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X POST \ https://{{host}}/api/public/adminroles/assignments/ \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '[{ "roleId":"5bre4bb433f78c73f4e5a0d1", "addUsers":["sample1@sampleemail.com"], "removeUsers":[], "addGroups": [], "removeGroups":[] }]
サンプル応答
[ { "status": "success " } ]