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 the Bot Admin Console.
| Method | GET |
| Endpoint | https://{{host}}/api/public/roles/export?roleType=admin |
| Content Type | application/json |
| Authorization |
|
| API Scope |
|
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| roleType | Required |
The role type:
|
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"
}
]