To retrieve the list of the bot or admin roles available in an account.
This API requires JWT generated by an application created only from the Bot Admin Console.
| Method | GET |
| Endpoint | https://{{host}}/api/public/roles?roleType=bot&limit=2 |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| roleType | Required | The role type:
|
| limit | Optional | The number of records to fetch. The maximum applicable limit is 50. |
Sample Request
curl -X GET \
'https://{{host}}/api/public/roles?roleType=bot&limit=2' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Sample Response (Admin)
{
"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": ""
}
]
}
Sample Response (bot)
{
"total": 5,
"availableMore": true,
"roles": [
{
"roleType": "bot",
"_id": "6495a4d56ca3571b556cf163",
"role": "Bot Owner",
"rDesc": "Role of bot owners with full access to bot definition",
"permissions": {
"Tasks": [
"FULL"
],
"Natural Language": [
"FULL"
],
"Knowledge Graph": [
"FULL"
],
"Testing": [
"FULL"
],
"Bot Developers": [
"FULL"
],
"Bot Settings": [
"FULL"
],
"Bot Import": [
"YES"
],
"Integrations & Extensions": [
"YES"
],
"Bot Builder API Scopes": [
"YES"
],
"Publish bot": [
"YES"
],
"Channels": [
"YES"
],
"Dashboard": [
"YES"
],
"Bot Analytics": [
"YES"
],
"Custom Dashboards": [
"FULL"
],
"Storyboard": [
"FULL"
],
"IntentDiscovery": [
"FULL"
]
}
},
{
"roleType": "bot",
"_id": "6495a4d56ca3571b556cf164",
"role": "Bot Developer",
"rDesc": "Role for bot co-developers",
"permissions": {
"Tasks": [
"FULL"
],
"Natural Language": [
"FULL"
],
"Knowledge Graph": [
"FULL"
],
"Bot Developers": [
"VIEW"
],
"Bot Settings": [
"FULL"
],
"Bot Import": [
"YES"
],
"Publish bot": [
"YES"
],
"Channels": [
"YES"
],
"Dashboard": [
"YES"
],
"Bot Analytics": [
"YES"
]
}
},
{
"roleType": "bot",
"_id": "6495a4d56ca3571b556cf165",
"role": "Bot Tester",
"rDesc": "Role for bot testers with read-only access to bot definition",
"permissions": {
"Tasks": [
"VIEW"
],
"Natural Language": [
"VIEW"
],
"Knowledge Graph": [
"VIEW"
],
"Bot Developers": [
"VIEW"
],
"Bot Settings": [
"NO"
],
"Bot Import": [
"NO"
],
"Publish bot": [
"NO"
],
"Channels": [
"NO"
],
"Dashboard": [
"YES"
],
"Bot Analytics": [
"YES"
]
}
}
]
}