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:
|
| fullImport | Optional |
|
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
}
]