관리자 역할 API 할당 – Kore.ai Documentation

관리자 역할에서 사용자 또는 그룹을 추가 또는 제거합니다.

이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 역할 관리 아래에 있는 역할 관리의 관리자 API 범위가 필요합니다.

POST https://{{host}}/api/public/adminroles/assignments/

쿼리 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)

본문 매개 변수

매개 변수	필수/선택 사항	설명
roleId	필수	사용자 또는 그룹에서 할당하거나 제거할 관리자 역할 ID입니다.
addUsers 또는 addOrgUserIds	선택 사항	관리자 역할을 할당할 사용자 이름 또는 조직 사용자 ID의 목록
removeUsers 또는 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 "
    }
]

管理者ロールからユーザーまたはグループを追加・削除します。

この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 " } ]

To add or remove users or groups from admin roles.

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/adminroles/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 admin role ID to assign or remove from users or groups
addUsers or addOrgUserIds	Optional	The list of usernames or org user ids for whom to assign the admin role
removeUsers or removeOrgUserIds	Optional	The list of usernames or org user ids for whom to remove the admin role
addGroups	Optional	The list of group names for whom to assign the admin role
removeGroups	Optional	The list of usernames for whom to remove the admin 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/adminroles/assignments/ \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '[{
"roleId":"5bre4bb433f78c73f4e5a0d1",
"addUsers":["sample1@sampleemail.com"],
"removeUsers":[],
"addGroups": [],
"removeGroups":[]
}]

Sample Response

[
    {
        "status": "success "
    }
]