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