봇이나 관리자 역할을 계정으로 가져옵니다. 이 기능은 일반적으로 한 환경에서 다른 환경으로 역할을 가져오는 데 사용됩니다.

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

POST https://{{host}}/api/public/roles/import?roleType=bot&fullImport=true

쿼리 매개 변수

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

가져올 역할 유형은 다음과 같습니다.

  • 관리자 또는
fullImport 선택 사항
  • 전체 가져오기의 경우 'true'이며
  • 증분 가져오기의 경우 'false'입니다.

본문 매개 변수

매개 변수 필수/선택 사항 설명
fileId 필수 가져오기 파일의 ID(파일이 업로드되는 클라우드 서비스에서 제공).

권한 부여

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

콘텐츠 유형 응답

application/json

샘플 요청

curl -X POST \
  'https://{{host}}/api/public/roles/import?roleType=admin&fullImport=true' \
  -H 'Content-Type: application/json' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '{
"fileId":"{{fileId}}"
}

샘플 응답

[
    {
        "mapping": {
            "users": [],
            "groups": [],
            "bots": []
        },
        "roleType": "admin",
        "rStatus": "unpublished",
        "isASystemRole": false,
        "category": "admin",
        "audit": [],
        "_userAndGroups": [],
        "isDefault": false,
        "_id": "5bf132388c4f4e433d46783b",
        "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b",
        "role": "CustomAdmin1",
        "createdDate": "2018-11-18T09:34:48.501Z",
        "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "modifiedDate": "2018-11-18T09:34:48.501Z",
        "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "permissions": {
            "Invite": "YES",
            "Import Users / Sync": "NO",
            "Directory Sync": "NO",
            "Manage Users": "NO",
            "Manage User Settings": "NO",
            "Manage Groups": "NO",
            "Manage Custom Admin Roles": "NO",
            "Manage Built-In Admin Roles": "NO",
            "Manage Bot Roles": "NO",
            "Manage Deployment": "NO",
            "Enterprise Bots": "NO",
            "Consumer Bots": "NO",
            "Smart Bots": "NO",
            "Preferences": "NO",
            "Single Sign On": "NO",
            "Kore.ai Connector": "NO",
            "Enterprise Key": "NO",
            "API Scopes": "NO",
            "View and Run Audit Reports": "NO",
            "View and Run Bot Chat History": "NO"
        },
        "rDesc": "",
        "refId": "a287e9fb-ea34-5835-a4c5-0c9a9d6136e0",
        "_product": "Bots",
        "__v": 0
    },
    {
        "mapping": {
            "users": [],
            "groups": [],
            "bots": []
        },
        "roleType": "admin",
        "rStatus": "unpublished",
        "isASystemRole": false,
        "category": "admin",
        "audit": [],
        "_userAndGroups": [],
        "isDefault": false,
        "_id": "5bf132388c4f4e433d46783c",
        "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b",
        "role": "CA2",
        "createdDate": "2018-11-18T09:34:48.501Z",
        "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "modifiedDate": "2018-11-18T09:34:48.501Z",
        "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "permissions": {
            "Invite": "NO",
            "Import Users / Sync": "NO",
            "Directory Sync": "YES",
            "Manage Users": "YES",
            "Manage User Settings": "NO",
            "Manage Groups": "NO",
            "Manage Custom Admin Roles": "NO",
            "Manage Built-In Admin Roles": "NO",
            "Manage Bot Roles": "YES",
            "Manage Deployment": "YES",
            "Enterprise Bots": "YES",
            "Consumer Bots": "YES",
            "Smart Bots": "YES",
            "Preferences": "NO",
            "Single Sign On": "NO",
            "Kore.ai Connector": "NO",
            "Enterprise Key": "NO",
            "API Scopes": "NO",
            "View and Run Audit Reports": "YES",
            "View and Run Bot Chat History": "YES"
        },
        "rDesc": "",
        "refId": "86ccb9c3-f63b-5a7e-be8b-dc9ee9748940",
        "_product": "Bots",
        "__v": 0
    }
]

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

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

ポスト https://{{host}}/api/public/roles/import?roleType=bot&fullImport=true

クエリパラメータ

パラメータ 必須/任意 説明
ホスト 必須 環境URL(例: https://bots.kore.ai)
roleType 必須 インポートするロールタイプ:

  • adminまたは
  • bot
fullImport 任意
  • 全体インポートの場合は「True」
  • 増分インポートの場合は「False

本文パラメータ

パラメータ 必須/任意 説明
fileId 必須 インポートファイルのID(ファイルをアップロードしたクラウドサービスから提供)です。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ 'https://{{host}}/api/public/roles/import?roleType=admin&fullImport=true' \ -H 'Content-Type: application/json' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -d '{ "fileId":"{{fileId}}" }

サンプル応答

[ { "mapping": { "users": [], "groups": [], "bots": [] }, "roleType": "admin", "rStatus": "unpublished", "isASystemRole": false, "category": "admin", "audit": [], "_userAndGroups": [], "isDefault": false, "_id": "5bf132388c4f4e433d46783b", "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b", "role": "CustomAdmin1", "createdDate": "2018-11-18T09:34:48.501Z", "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7", "modifiedDate": "2018-11-18T09:34:48.501Z", "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7", "permissions": { "Invite": "YES", "Import Users / Sync": "NO", "Directory Sync": "NO", "Manage Users": "NO", "Manage User Settings": "NO", "Manage Groups": "NO", "Manage Custom Admin Roles": "NO", "Manage Built-In Admin Roles": "NO", "Manage Bot Roles": "NO", "Manage Deployment": "NO", "Enterprise Bots": "NO", "Consumer Bots": "NO", "Smart Bots": "NO", "Preferences": "NO", "Single Sign On": "NO", "Kore.ai Connector": "NO", "Enterprise Key": "NO", "API Scopes": "NO", "View and Run Audit Reports": "NO", "View and Run Bot Chat History": "NO" }, "rDesc": "", "refId": "a287e9fb-ea34-5835-a4c5-0c9a9d6136e0", "_product": "Bots", "__v": 0 }, { "mapping": { "users": [], "groups": [], "bots": [] }, "roleType": "admin", "rStatus": "unpublished", "isASystemRole": false, "category": "admin", "audit": [], "_userAndGroups": [], "isDefault": false, "_id": "5bf132388c4f4e433d46783c", "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b", "role": "CA2", "createdDate": "2018-11-18T09:34:48.501Z", "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7", "modifiedDate": "2018-11-18T09:34:48.501Z", "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7", "permissions": { "Invite": "NO", "Import Users / Sync": "NO", "Directory Sync": "YES", "Manage Users": "YES", "Manage User Settings": "NO", "Manage Groups": "NO", "Manage Custom Admin Roles": "NO", "Manage Built-In Admin Roles": "NO", "Manage Bot Roles": "YES", "Manage Deployment": "YES", "Enterprise Bots": "YES", "Consumer Bots": "YES", "Smart Bots": "YES", "Preferences": "NO", "Single Sign On": "NO", "Kore.ai Connector": "NO", "Enterprise Key": "NO", "API Scopes": "NO", "View and Run Audit Reports": "YES", "View and Run Bot Chat History": "YES" }, "rDesc": "", "refId": "86ccb9c3-f63b-5a7e-be8b-dc9ee9748940", "_product": "Bots", "__v": 0 } ]

To import bot or admin roles into an account. This is typically used to import 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.

POST https://{{host}}/api/public/roles/import?roleType=bot&fullImport=true

Query Parameters

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

  • admin or
  • bot
fullImport Optional
  • ‘true‘ for full import and
  • false‘ for incremental import.

Body Parameters

Parameter Required/Optional Description
fileId Required The ID of the import file (provided by the cloud service where the file is uploaded).

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/roles/import?roleType=admin&fullImport=true' \
  -H 'Content-Type: application/json' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '{
"fileId":"{{fileId}}"
}

Sample Response

[
    {
        "mapping": {
            "users": [],
            "groups": [],
            "bots": []
        },
        "roleType": "admin",
        "rStatus": "unpublished",
        "isASystemRole": false,
        "category": "admin",
        "audit": [],
        "_userAndGroups": [],
        "isDefault": false,
        "_id": "5bf132388c4f4e433d46783b",
        "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b",
        "role": "CustomAdmin1",
        "createdDate": "2018-11-18T09:34:48.501Z",
        "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "modifiedDate": "2018-11-18T09:34:48.501Z",
        "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "permissions": {
            "Invite": "YES",
            "Import Users / Sync": "NO",
            "Directory Sync": "NO",
            "Manage Users": "NO",
            "Manage User Settings": "NO",
            "Manage Groups": "NO",
            "Manage Custom Admin Roles": "NO",
            "Manage Built-In Admin Roles": "NO",
            "Manage Bot Roles": "NO",
            "Manage Deployment": "NO",
            "Enterprise Bots": "NO",
            "Consumer Bots": "NO",
            "Smart Bots": "NO",
            "Preferences": "NO",
            "Single Sign On": "NO",
            "Kore.ai Connector": "NO",
            "Enterprise Key": "NO",
            "API Scopes": "NO",
            "View and Run Audit Reports": "NO",
            "View and Run Bot Chat History": "NO"
        },
        "rDesc": "",
        "refId": "a287e9fb-ea34-5835-a4c5-0c9a9d6136e0",
        "_product": "Bots",
        "__v": 0
    },
    {
        "mapping": {
            "users": [],
            "groups": [],
            "bots": []
        },
        "roleType": "admin",
        "rStatus": "unpublished",
        "isASystemRole": false,
        "category": "admin",
        "audit": [],
        "_userAndGroups": [],
        "isDefault": false,
        "_id": "5bf132388c4f4e433d46783c",
        "orgId": "o-d52dc1a4-8ef6-5fbf-943a-b572b469ec3b",
        "role": "CA2",
        "createdDate": "2018-11-18T09:34:48.501Z",
        "createdBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "modifiedDate": "2018-11-18T09:34:48.501Z",
        "modifiedBy": "u-66bb4537-6a44-5127-b6e2-c97e4e66d5b7",
        "permissions": {
            "Invite": "NO",
            "Import Users / Sync": "NO",
            "Directory Sync": "YES",
            "Manage Users": "YES",
            "Manage User Settings": "NO",
            "Manage Groups": "NO",
            "Manage Custom Admin Roles": "NO",
            "Manage Built-In Admin Roles": "NO",
            "Manage Bot Roles": "YES",
            "Manage Deployment": "YES",
            "Enterprise Bots": "YES",
            "Consumer Bots": "YES",
            "Smart Bots": "YES",
            "Preferences": "NO",
            "Single Sign On": "NO",
            "Kore.ai Connector": "NO",
            "Enterprise Key": "NO",
            "API Scopes": "NO",
            "View and Run Audit Reports": "YES",
            "View and Run Bot Chat History": "YES"
        },
        "rDesc": "",
        "refId": "86ccb9c3-f63b-5a7e-be8b-dc9ee9748940",
        "_product": "Bots",
        "__v": 0
    }
]