계정에서 사용할 수 있는 봇 또는 관리자 역할 목록을 검색합니다.

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

GET https://{{host}}/api/public/roles?roleType=bot&limit=2

쿼리 매개 변수

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

역할 유형:

  • 관리자 또는
  • 봇
limit 선택 사항 가져올 레코드 수입니다. 적용할 수 있는 최대 한도는 50입니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다: auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X GET \
  'https://{{host}}/api/public/roles?roleType=bot&limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

샘플 응답

{
    "total": 2,
    "availableMore": false,
    "roles": [
        {
            "roleType": "admin",
            "role": "admin",
            "rDesc": "Master administration role with full control on account activity",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "YES",
                "Directory Sync": "YES",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Password Policies": "YES",
                "Single Sign On": "YES",
                "Domain Management": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "Consumer Bots": "YES",
                "View and Run Bot Chat History": "YES",
                "Manage Bot Roles": "YES",
                "Preferences": "YES",
                "Smart Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            }
        },
        {
            "roleType": "admin",
            "role": "sample admin",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "NO",
                "Directory Sync": "NO",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Smart Bots": "YES",
                "Preferences": "YES",
                "Single Sign On": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Bot Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "View and Run Bot Chat History": "YES",
                "Consumer Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            },
            "rDesc": ""
        }
    ]
}

アカウントで利用可能なボットまたは管理者のロールのリストを取得します。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/roles?roleType=bot&limit=2

クエリパラメータ

パラメータ 必須/任意 説明
ホスト 必須 環境URL（例： https://bots.kore.ai）
roleType 必須 ロールタイプ：

  • adminまたは
  • bot
limit 任意 取得する記録数です。最大値は50です。

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ 'https://{{host}}/api/public/roles?roleType=bot&limit=2' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

{ "total": 2, "availableMore": false, "roles": [ { "roleType": "admin", "role": "admin", "rDesc": "Master administration role with full control on account activity", "permissions": { "Invite": "YES", "Import Users / Sync": "YES", "Directory Sync": "YES", "Manage User Profile Fields": "YES", "Manage Groups": "YES", "Manage Deployment": "YES", "Enterprise Bots": "YES", "Password Policies": "YES", "Single Sign On": "YES", "Domain Management": "YES", "Kore.ai Connector": "YES", "Manage Built-In Admin Roles": "YES", "Manage Custom Admin Roles": "YES", "View and Run Audit Reports": "YES", "Consumer Bots": "YES", "View and Run Bot Chat History": "YES", "Manage Bot Roles": "YES", "Preferences": "YES", "Smart Bots": "YES", "API Scopes": "YES", "Enterprise Key": "YES" } }, { "roleType": "admin", "role": "sample admin", "permissions": { "Invite": "YES", "Import Users / Sync": "NO", "Directory Sync": "NO", "Manage User Profile Fields": "YES", "Manage Groups": "YES", "Manage Deployment": "YES", "Enterprise Bots": "YES", "Smart Bots": "YES", "Preferences": "YES", "Single Sign On": "YES", "Kore.ai Connector": "YES", "Manage Built-In Admin Roles": "YES", "Manage Bot Roles": "YES", "Manage Custom Admin Roles": "YES", "View and Run Audit Reports": "YES", "View and Run Bot Chat History": "YES", "Consumer Bots": "YES", "API Scopes": "YES", "Enterprise Key": "YES" }, "rDesc": "" } ] }

To retrieve the list of bot or admin roles available in an account.

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.

GET https://{{host}}/api/public/roles?roleType=bot&limit=2

Query Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
roleType Required The role type:

  • admin or
  • bot
limit Optional The number of records to fetch. The maximum applicable limit is 50.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \
  'https://{{host}}/api/public/roles?roleType=bot&limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "total": 2,
    "availableMore": false,
    "roles": [
        {
            "roleType": "admin",
            "role": "admin",
            "rDesc": "Master administration role with full control on account activity",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "YES",
                "Directory Sync": "YES",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Password Policies": "YES",
                "Single Sign On": "YES",
                "Domain Management": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "Consumer Bots": "YES",
                "View and Run Bot Chat History": "YES",
                "Manage Bot Roles": "YES",
                "Preferences": "YES",
                "Smart Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            }
        },
        {
            "roleType": "admin",
            "role": "sample admin",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "NO",
                "Directory Sync": "NO",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Smart Bots": "YES",
                "Preferences": "YES",
                "Single Sign On": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Bot Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "View and Run Bot Chat History": "YES",
                "Consumer Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            },
            "rDesc": ""
        }
    ]
}