{"id":18082,"date":"2018-11-24T08:20:43","date_gmt":"2018-11-24T08:20:43","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15538"},"modified":"2023-07-26T16:09:27","modified_gmt":"2023-07-26T15:09:27","slug":"assign-bt-roles-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/assign-bt-roles-api\/","title":{"rendered":"Assign BT Roles API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To assign a bot role to a set of users in a specific bot.<\/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>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/btroles\/assignments\/<\/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
    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\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n
    curl -X POST \\\r\nhttps:\/\/{{host}}\/api\/public\/btroles\/assignments\/ \\\r\n-H 'Content-Type: application\/json' \\\r\n-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n-d '[{\r\n\"roleId\":\"5bee8fv6729d35741e05aba4\",\r\n\"botId\":\"{{botId}}\",\r\n\"addUsers\":[\"\"],\r\n\"removeUsers\":[\"\"],\r\n\"addGroups\": [\"G2\"],\r\n\"removeGroups\":[\"\"]\r\n}]'<\/pre>\n
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n
    roleId<\/td>\nRequired<\/td>\nThe ID of the bot role to assign the users or groups.<\/td>\n<\/tr>\n
    botId<\/td>\nRequired<\/td>\nThe ID of the bot in which to assign the bot roles<\/td>\n<\/tr>\n
    addUsers or addOrgUserIds<\/td>\nOptional<\/td>\nThe list of usernames or org user ids for whom to assign the bot role<\/td>\n<\/tr>\n
    removeUsers or removeOrgUserIds<\/td>\nOptional<\/td>\nThe list of usernames or org user ids for whom to remove the bot role<\/td>\n<\/tr>\n
    addGroups<\/td>\nOptional<\/td>\nThe list of group names for whom to assign the bot role<\/td>\n<\/tr>\n
    removeGroups<\/td>\nOptional<\/td>\nThe list of group names for whom to remove the bot role<\/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
     <\/p>\n
    Sample Response<\/span><\/h2>\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 assign a bot role to a set of users in a specific bot. This API requires JWT generated by an application created only from the Bot Admin Console. Method POST Endpoint https:\/\/{{host}}\/api\/public\/btroles\/assignments\/ Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Profile...","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-18082","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\/18082","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=18082"}],"version-history":[{"count":18,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18082\/revisions"}],"predecessor-version":[{"id":58429,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18082\/revisions\/58429"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18082"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18082"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18082"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}