Update User API3 min read

To update user details.

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 User Management under Security & Control.

PUT https://{{host}}/api/public/users

NOTE: This feature was introduced in ver7.1 of the platform.

Query Parameters

Parameter	Description
host	Environment URL, for example, https://bots.kore.ai

Body Parameters

Parameter

Description

users

The array of details for each user that need to be updated

userInfo.emailId

or userInfo.orgUserId

(mandatory)

Email Ids or the org user id of the user being updated

userInfo.firstName
(optional)

First name of the user if needs to be updated

userInfo.lastName
(optional)

Last name of the user if needs to be updated

userInfo.companyName
(optional)

Company to which the user if needs to be updated

userInfo.dept
(optional)

Department to which the user if needs to be updated

userInfo.companyContactPhone
(optional)

Contact Phone of the Company to which the user belongs if needs to be updated

userInfo.worknumber
(optional)

Work number of the user if needs to be updated

userInfo.street
(optional)

Street Address of the user if needs to be updated

userInfo.suiteNo
(optional)

Suite No Address of the user if needs to be updated

userInfo.city
(optional)

City Address of the user if needs to be updated

userInfo.zip
(optional)

Zip Address of the user if needs to be updated

userInfo.state
(optional)

State Address of the user if needs to be updated

userInfo.country
(optional)

Country Address of the user if needs to be updated

groups
(optional)

array of group ids to which the user needs to be addTo or removeFrom

roles
(optional)

array of roleId-botId combinations to which the user needs to be addTo or removeFrom

assignBotTasks
(optional)

array of bots that have to be assigned to the user. If not present, the current assignment will be retained.

botId	Id of the Bot to be assigned to the user. If not given, all the previous assigned bots will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.
dialogs	Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned

canCreateBot
(optional)

Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.

isDeveloper
(optional)

Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X PUT \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>,
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
      	       ],
            "canCreateBot": true,
            "isDeveloper": true
        }
	]
}
'

Sample Response

For success case:

{
        "msg": "Users are updated Successfully"
    };

On this Page