Get User Roles Details API

Back to API List To get complete information of all users and their associated roles in the account.

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

Field	Value
Method	GET
Endpoint	`https://{{host}}/api/public/alluserroles?includeMeta=true`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	App Builder: Not Applicable; Admin Console: Profile Management > Role Management

Path Parameters

Parameter	Description
`host`	Environment URL, for example, `https://platform.kore.ai`.

Query Parameters

Parameter	Type	Description
`includeMeta`	boolean	Set to true for encrypted response. Default: False

Sample Request

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

Sample Response

{
    "total": 10,
    "availableMore": true,
    "users": [
        {
            "username": "john.doe@example.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [],
            "adminRoles": []
        },
        {
            "username": "jane.doe@example.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [
                {
                    "roleId": "5c04ae921ad9976d311xxxxx",
                    "roleName": "App Developer",
                    "groups": [],
                    "botId": "st-fd7c7396-xxxx-5916-972d-6bfe690xxxxx",
                    "botName": "Banking AI Agent"
                }
            ],
            "adminRoles": []
        }
    ]
}

Response Parameters

Parameter	Type	Description
`moreAvailable`	Boolean	Indicates if more records are available for retrieval.
`total`	Optional	The total count of available records.

​Path Parameters

​Query Parameters

​Sample Request

​Sample Response

​Response Parameters

Path Parameters

Query Parameters

Sample Request

Sample Response

Response Parameters