{"id":18093,"date":"2018-12-06T06:38:20","date_gmt":"2018-12-06T06:38:20","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15800"},"modified":"2023-11-27T08:19:05","modified_gmt":"2023-11-27T08:19:05","slug":"get-user-roles-details-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/get-user-roles-details-api\/","title":{"rendered":"Get User Roles Details API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To get complete information on all the users and their associated roles in the account.<\/p>\n

This API requires JWT generated by an application created only from the Bot Admin Console.<\/p>\n\n\n\n\n\n\n\n
Method<\/strong><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/alluserroles?limit=2<\/code><\/td>\n<\/tr>\n
Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: Not Applicable<\/li>\n
  • Admin Console: Profile Management > Role Management<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
    limit<\/td>\nIndicates the number of records to be returned in the result set.<\/td>\n<\/tr>\n
    offset<\/td>\nThe number of records to be skipped from the result set.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n
    curl -X GET \\   \r\n  https:\/\/{{host}}\/api\/public\/alluserroles?limit=2' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    {\r\n    \"total\": 10,\r\n    \"availableMore\": true,\r\n    \"users\": [\r\n        {\r\n            \"username\": \"<name>@kore.com\",\r\n            \"orgUserId\": \"org assigned user id\",\r\n            \"accountId\": \"<id>\",\r\n            \"isDeveloper\": true,\r\n            \"canCreateBot\": true,\r\n            \"userId\": \"u-xxx-xxx-xxx-xxx-xxxxx\",\r\n            \"btRoles\": [],\r\n            \"adminRoles\": []\r\n        },\r\n        {\r\n            \"username\": \"<name>@kore.com\",\r\n            \"orgUserId\": \"org assigned user id\",\r\n            \"accountId\": \"<id>\",\r\n            \"isDeveloper\": true,\r\n            \"canCreateBot\": true,\r\n            \"userId\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"btRoles\": [\r\n                {\r\n                    \"roleId\": \"5c04ae921ad9976d311e9b50\",\r\n                    \"roleName\": \"Bot Developer\",\r\n                    \"groups\": [],\r\n                    \"botId\": \"st-fd7c7396-82c1-5916-972d-6bfe6908b5ab\",\r\n                    \"botName\": \"Example Bot\"\r\n                }\r\n            ],\r\n            \"adminRoles\": []\r\n        }\r\n    ]\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To get complete information on all the users and their associated roles in the account. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https:\/\/{{host}}\/api\/public\/alluserroles?limit=2 Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console:...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18093","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18093","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18093"}],"version-history":[{"count":16,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18093\/revisions"}],"predecessor-version":[{"id":60369,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18093\/revisions\/60369"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18093"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18093"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18093"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}