1. Home
  2. Kore.ai Conversational Platform
  3. SDKs & APIs
  4. Using Kore.ai APIs
  5. Get Roles API

Get Roles API

To retrieve the list of bot or admin roles available in an account.

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

Query Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
roleType Required The role type: admin or bot
offset Optional Specify the page number from which to start fetching the admin or user roles. If unspecified, it starts from 0, which is the first page of the list of roles.
limit Optional The number of records to fetch. The maximum applicable limit is 50.

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 \

'http://{{host}}/api/public/roles?roleType=admin' \

-H 'auth: YOUR_JWT_ACCESS_TOKEN' \

Sample Response

{
    "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": ""
        }       
    ]
}

Was this article helpful to you? Yes No