Get User Roles Details API1 min read

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

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.

GET https://{{host}}/api/public/alluserroles?

Query Parameters

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