Skip to content

Update User Access API

To add or remove the ability to access bot builder to create new bots.

Note

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

Method POST
Endpoint https://{{host}}/api/public/useraccess
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Role Management

Path Parameters

PARAMETER DESCRIPTION
host Environment URL, for example, https://bots.kore.ai

Sample Request

curl -X POST 'https://{{host}}/api/public/useraccess' \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
"emailIds":["sample1@sampleemail.com"],
"canCreateBot":true,
"isDeveloper":true,
"hasDataTableAndViewAccess": true
}'

Body Parameters

PARAMETER DESCRIPTION
emailIds The array of user email Ids whose access permissions have to be changed, for example, [“joe@kore.com”, “amy@xyz.com”]
canCreateBot Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
isDeveloper Determines if the specified users can have access to Bot Builder. Set to true or false.
hasDataTableAndViewAccess Determines if the specified users can create tables and views. Set to true or false.

Sample Response

For success case:

[
  "SUCCESS"
]

  • Invalid input combination: canCreateBot: true, isDeveloper: false

    {
  "errors": [ 
      { 
        "msg": "Invalid values in the body", 
        "code": 403 
       } 
       ] 
}

  • No email addresses provided: emailIds [ ] is empty 

    {
  "errors": [
      { "msg": "emailIds cannot be empty", 
        "code": 400 } 
   ] 
}

  • Invalid email id or any email which is not present in DB (Which is associated with the account)

    {
  "errors": [
    { "msg": "One or more entered emails not found",
      "code": 400 }

            ]
}

  • One or more emailIds belong to other accounts

    json { "errors": [ { "msg": "Emails << vishxxxxx@domain.com >> not associated with your account", "code": 400 } ] }