{"id":18083,"date":"2018-11-24T08:30:00","date_gmt":"2018-11-24T08:30:00","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15541"},"modified":"2021-03-25T07:47:28","modified_gmt":"2021-03-25T07:47:28","slug":"assign-admin-roles-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/assign-admin-roles-api\/","title":{"rendered":"Assign Admin Roles API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To add or remove users or groups from admin roles.<\/p>\n

This API requires JWT generated by an application created only from Bot Admin Console.
\nTo use this API, app needs the Admin API Scope of Role Management<\/em> under Role Management<\/em>.<\/p>\n

POST <\/b>https:\/\/{{host}}\/api\/public\/adminroles\/assignments\/<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n
Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n
host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n
roleId<\/td>\nRequired<\/td>\nThe admin role ID to assign or remove from users or groups<\/td>\n<\/tr>\n
addUsers or addOrgUserIds<\/td>\nOptional<\/td>\nThe list of usernames or org user ids for whom to assign the admin role<\/td>\n<\/tr>\n
removeUsers or removeOrgUserIds<\/td>\nOptional<\/td>\nThe list of usernames or org user ids for whom to remove the admin role<\/td>\n<\/tr>\n
addGroups<\/td>\nOptional<\/td>\nThe list of group names for whom to assign the admin role<\/td>\n<\/tr>\n
removeGroups<\/td>\nOptional<\/td>\nThe list of usernames for whom to remove the admin role<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/adminroles\/assignments\/ \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '[{\r\n\"roleId\":\"5bre4bb433f78c73f4e5a0d1\",\r\n\"addUsers\":[\"sample1@sampleemail.com\"],\r\n\"removeUsers\":[],\r\n\"addGroups\": [],\r\n\"removeGroups\":[]\r\n}]<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
[\r\n    {\r\n        \"status\": \"success \"\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 add or remove users or groups from admin roles. 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. POST https:\/\/{{host}}\/api\/public\/adminroles\/assignments\/ Query Parameters Parameter Required\/Optional Description host Required Environment URL, for example, https:\/\/bots.kore.ai Body...","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-18083","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18083","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18083"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18083\/revisions"}],"predecessor-version":[{"id":22898,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18083\/revisions\/22898"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18083"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18083"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18083"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}