특정 봇의 사용자 집합에 봇 역할을 할당합니다
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 역할 관리 아래에 있는 역할 관리의 관리자 API 범위가 필요합니다.
POST https://{{host}}/api/public/btroles/assignments/
쿼리 매개 변수
| 매개 변수 | 필수/선택 사항 | 설명 |
|---|---|---|
| host | 필수 | 환경 URL(예: https://bots.kore.ai) |
본문 매개 변수
| 매개 변수 | 필수/선택 사항 | 설명 |
|---|---|---|
| roleId | 필수 | 사용자 또는 그룹을 할당할 봇 역할의 ID입니다. |
| botId | 필수 | 봇 역할을 할당할 봇의 ID입니다 |
| addUsers 또는 addOrgUserIds | 선택 사항 | 봇 역할을 할당할 사용자 이름 또는 조직 사용자 ID 목록 |
| removeUsers 또는 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 "
}
]
特定のボットのまとまったユーザーにボットのロールを割り当てます。
この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 " } ]
To assign a bot role to a set of users in a specific bot.
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 Role Management under Role Management.
POST https://{{host}}/api/public/btroles/assignments/
Query Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
Body Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| roleId | Required | The ID of the bot role to assign the users or groups. |
| botId | Required | The ID of the bot in which to assign the bot roles |
| addUsers or addOrgUserIds | Optional | The list of usernames or org user ids for whom to assign the bot role |
| removeUsers or removeOrgUserIds | Optional | The list of usernames or org user ids for whom to remove the bot role |
| addGroups | Optional | The list of group names for whom to assign the bot role |
| removeGroups | Optional | The list of group names for whom to remove the bot role |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
Sample Request
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":[""]
}]
Sample Response
[
{
"status": "success "
}
]