{"id":18084,"date":"2018-11-24T08:36:04","date_gmt":"2018-11-24T08:36:04","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15545"},"modified":"2021-03-25T11:15:36","modified_gmt":"2021-03-25T11:15:36","slug":"update-user-access-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/update-user-access-api\/","title":{"rendered":"Update User Access API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To add or remove the ability to access bot builder, create new bots.<\/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

GET <\/b>https:\/\/{{host}}\/api\/public\/useraccess<\/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>\nDescription<\/th>\n<\/tr>\n
host<\/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
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
emailIds<\/td>\nThe array of user email Ids whose access permissions have to be changed, for example, [“joe@kore.com”, “amy@xyz.com”]<\/td>\n<\/tr>\n
canCreateBot<\/td>\nDetermines if the specified users can create bots in their Bot Builder accounts. Set to true or false.<\/td>\n<\/tr>\n
isDeveloper<\/td>\nDetermines if the specified users can have access to Bot Builder. Set to true or false.<\/td>\n<\/tr>\n
hasDataTableAndViewAccess<\/td>\nDetermines if the specified users can create tables and views. Set to true or false.<\/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\/useraccess \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '{\r\n\"emailIds\":[\"sample1@sampleemail.com\"],\r\n\"canCreateBot\":true,\r\n\"isDeveloper\":true,\r\n\"hasDataTableAndViewAccess\": true\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
    \n
  • For success case:\n
    [\r\n  \u201cSUCCESS\u201d\r\n]<\/pre>\n<\/li>\n
  • Invalid input combination: canCreateBot: true, isDeveloper: false\n
    { \r\n  \"errors\": [ \r\n      { \r\n        \"msg\": \"Invalid values in the body\", \r\n        \"code\": 403 \r\n       } \r\n       ] \r\n }<\/pre>\n<\/li>\n
  • No email addresses provided: emailIds [ ] is empty\n
    {\r\n  \"errors\": [\r\n      { \"msg\": \"emailIds cannot be empty\", \r\n        \"code\": 400 } \r\n   ] \r\n }<\/pre>\n<\/li>\n
  • Invalid email id or any email which is not present in DB (Which is associated with the account)\n
    {\r\n  \"errors\": [\r\n    { \"msg\": \"One or more entered emails not found\",\r\n      \"code\": 400 }\r\n    ]\r\n }<\/pre>\n<\/li>\n
  • One or more emailIds belong to other accounts\n
    {\r\n  \"errors\": [ \r\n    { \"msg\": \"Emails <> not associated with your account\",\r\n      \"code\": 400 }\r\n    ]\r\n }<\/pre>\n<\/li>\n<\/ul>\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 the ability to access bot builder, create new bots. 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\/useraccess Query Parameters Parameter Description host Environment URL, for example, https:\/\/bots.kore.ai...","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-18084","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\/18084","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=18084"}],"version-history":[{"count":11,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18084\/revisions"}],"predecessor-version":[{"id":23656,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18084\/revisions\/23656"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18084"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18084"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18084"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}