계정에서 봇 또는 관리자 역할을 내보냅니다. 이 기능은 일반적으로 한 환경에서 다른 환경으로 역할을 내보내는 데 사용됩니다.

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

GET https://{{host}}/api/public/roles/export?roleType=admin

쿼리 매개 변수

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

역할 유형:

  • 관리자 또는
  • 봇

권한 부여

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

콘텐츠 유형 응답

application/json

샘플 요청

curl -X GET \
  'https://{{host}}/api/public/roles/export?roleType=bot' \
  -H 'Content-Type: application/json' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

샘플 응답

[
{
        "roleType": "admin",
        "_id": "5bd057cc2515025b2a4da326",
        "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"
        },
        "refId": "891ce307-f69f-5b9b-9c92-3945ce299e81"
    },
{
        "roleType": "admin",
        "_id": "5bd83485d01df415735a3a51",
        "role": "admin check11",
        "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": "",
        "refId": "41bce522-fed8-5efc-b2b0-3d2376b86657"
    }
]

ボットまたは管理者ロールをアカウントからエクスポートします。これは通常、ある環境から別の環境にロールをエクスポートするために使用されます。

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

GET https://{{host}}/api/public/roles/export?roleType=admin

クエリパラメータ

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

  • adminまたは
  • bot

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ 'https://{{host}}/api/public/roles/export?roleType=bot' \ -H 'Content-Type: application/json' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

[ { "roleType": "admin", "_id": "5bd057cc2515025b2a4da326", "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" }, "refId": "891ce307-f69f-5b9b-9c92-3945ce299e81" }, { "roleType": "admin", "_id": "5bd83485d01df415735a3a51", "role": "admin check11", "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": "", "refId": "41bce522-fed8-5efc-b2b0-3d2376b86657" } ]

To export bot or admin roles from an account. This is typically used to export roles from one environment to another.

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/export?roleType=admin

Query Parameters

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

  • admin or
  • bot

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/export?roleType=bot' \
  -H 'Content-Type: application/json' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

[
{
        "roleType": "admin",
        "_id": "5bd057cc2515025b2a4da326",
        "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"
        },
        "refId": "891ce307-f69f-5b9b-9c92-3945ce299e81"
    },
{
        "roleType": "admin",
        "_id": "5bd83485d01df415735a3a51",
        "role": "admin check11",
        "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": "",
        "refId": "41bce522-fed8-5efc-b2b0-3d2376b86657"
    }
]