Skip to content

Get User Roles Details API

To get complete information of all the users and their associated roles in the account.

Note

This API requires JWT generated by an application created only from the Bot Admin Console.

Method GET
Endpoint https://{{host}}/api/public/alluserroles?
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Role Management

Path Parameters

PARAMETER DESCRIPTION
host Environment URL, for example, https://bots.kore.ai

Sample Request

curl -X GET \   
  https://{{host}}/api/public/alluserroles?limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "total": 10,
    "availableMore": true,
    "users": [
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [],
            "adminRoles": []
        },
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [
                {
                    "roleId": "5c04ae921ad9976d311e9b50",
                    "roleName": "Bot Developer",
                    "groups": [],
                    "botId": "st-fd7c7396-82c1-5916-972d-6bfe6908b5ab",
                    "botName": "Example Bot"
                }
            ],
            "adminRoles": []
        }
    ]
}