{"id":22685,"date":"2019-11-01T11:29:40","date_gmt":"2019-11-01T11:29:40","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=22685"},"modified":"2021-03-25T08:56:04","modified_gmt":"2021-03-25T08:56:04","slug":"create-user-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/create-user-api\/","title":{"rendered":"Create User API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To add users to an account.<\/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 User Management<\/em> under Security & Control<\/em>.<\/p>\n

POST <\/b>https:\/\/{{host}}\/api\/public\/users<\/code><\/p>\n

NOTE: This feature was introduced in ver7.1 of the platform.<\/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
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
users<\/td>\nThe array of details for each user to include user email id, user first name, group to which the user will belong, roles to be assigned to the Bots, and the permissions<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
userInfo.emailId
\n(mandatory)<\/td>\n		Email Ids of the user being added<\/td>\n<\/tr>\n
userInfo.orgUserId
\n(optional)<\/td>\n		User id assigned by your organization of the user being added<\/td>\n<\/tr>\n
userInfo.firstName
\n(optional)<\/td>\n		First name of the user being added<\/td>\n<\/tr>\n
userInfo.lastName
\n(optional)<\/td>\n		Last name of the user being added<\/td>\n<\/tr>\n
userInfo.companyName
\n(optional)<\/td>\n		Company to which the user being added belongs<\/td>\n<\/tr>\n
userInfo.dept
\n(optional)<\/td>\n		Department to which the user being added belongs<\/td>\n<\/tr>\n
userInfo.companyContactPhone
\n(optional)<\/td>\n		Contact Phone of the Company to which the user being added belongs<\/td>\n<\/tr>\n
userInfo.worknumber
\n(optional)<\/td>\n		Work number of the user being added<\/td>\n<\/tr>\n
userInfo.street
\n(optional)<\/td>\n		Street Address of the user being added<\/td>\n<\/tr>\n
userInfo.suiteNo
\n(optional)<\/td>\n		Suite No Address of the user being added<\/td>\n<\/tr>\n
userInfo.city
\n(optional)<\/td>\n		City Address of the user being added<\/td>\n<\/tr>\n
userInfo.zip
\n(optional)<\/td>\n		Zip Address of the user being added<\/td>\n<\/tr>\n
userInfo.state
\n(optional)<\/td>\n		State Address of the user being added<\/td>\n<\/tr>\n
userInfo.country
\n(optional)<\/td>\n		Country Address of the user being added<\/td>\n<\/tr>\n
groups
\n(optional)<\/td>\n		array of group ids to which the user should belong<\/td>\n<\/tr>\n
roles
\n(optional)<\/td>\n		array of roleId-botId combinations saying what role the user has on which bot<\/td>\n<\/tr>\n
assignBotTasks
\n(optional)<\/td>\n		array of bots that need to be assigned to the user<\/p>\n\n\n\n\n\n\n\n
botId<\/td>\nId of the Bot to be assigned to the user<\/td>\n<\/tr>\n
dialogs<\/td>\nArray of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
canCreateBot
\n(optional)<\/td>\n		Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
\nDefault value is “true”.<\/em><\/td>\n<\/tr>\n
isDeveloper
\n(optional)<\/td>\n		Determines if the specified users can have access to Bot Builder. Set to true or false.
\nDefault value is “true”.<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
sendEmail
\n(optional)<\/td>\n		Determines if an email needs to be sent to the user containing activation link to activate users under the account. Set to true or false.
\nDefault value is “true”.<\/em><\/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\/users \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '{\r\n    \"users\": [\r\n        {\r\n            \"userInfo\": {\r\n                \"emailId\": \"deskkore1@gmail.com\",\r\n                \"orgUserId\": \"org assigned user id\",\r\n                \"firstName\": \"user1\",\r\n                \"lastName\":\"user1\",\r\n                \"companyName\":\"company_name\",\r\n                \"dept\":\"dept\",\r\n                \"companyContactPhone\":\"12334444\",\r\n                \"worknumber\":\"321\",\r\n                \"street\":\"street\",\r\n                \"suiteNo\":\"suite\",\r\n                \"city\":\"city\",\r\n                \"zip\":\"123123\",\r\n                \"state\":\"state\",\r\n                \"country\":\"country\"\r\n            },\r\n            \"groups\": [\r\n                \"e-06b41cdd-7678-5394-b958-40ca5662f502\"\r\n            ],\r\n            \"roles\": [\r\n                {\r\n                    \"roleId\": \"5d9d8db30d54920a8df1e68b\",\r\n                    \"botId\": \"st-b8525f88-6dd3-54a7-8a97-734ecb748733\"\r\n                },\r\n                {\r\n                    \"roleId\": \"5d9d920dabdc1e6e8ec99342\",\r\n                    \"botId\": \"st-16511425-15c5-5cdf-b652-a796db7d134b\"\r\n                },\r\n                {\r\n                    \"roleId\": \"5bbcb20c8bfd33db440ec1d1\"\r\n                },\r\n                {\r\n                    \"roleId\": \"5d9d8d930d54920a8df1e689\"\r\n                }         \r\n            ],\r\n            \"assignBotTasks\": [\r\n              {\r\n                \"botId\": \"st-xxx-xx-xxx-xxx-xxxx\",\r\n                \"dialogs\": [\"dg-xxxx-xx-xx-xx-xxxx\"]\r\n               } \r\n            ],\r\n            \"canCreateBot\": true,\r\n            \"isDeveloper\": true\r\n        }\r\n]\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        \"msg\": \"Users are created Successfully\"\r\n    };<\/pre>\n<\/li>\n
  • Failure case:\n
    {\r\n    \"failedUserDetails\": [\r\n        {\r\n            \"userInfo\": {\r\n                \"emailId\": \"deskkore1\",\r\n                \"firstName\": \"user1\",\r\n                \"status\": \"failure\",\r\n                \"reason\": {\r\n                    \"statusCode\": 400,\r\n                    \"status\": 400,\r\n                    \"customCode\": 400,\r\n                    \"errors\": [\r\n                        {\r\n                            \"msg\": \"INVALID_EMAIL\",\r\n                            \"code\": 400\r\n                        }\r\n                    ],\r\n                    \"_headers\": {},\r\n                    \"message\": \"INVALID_EMAIL\",\r\n                    \"name\": \"BadRequest\"\r\n                }\r\n            }\r\n        }\r\n]\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 users to an account. 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. POST https:\/\/{{host}}\/api\/public\/users NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters Parameter Description host Environment...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-22685","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\/22685","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=22685"}],"version-history":[{"count":10,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22685\/revisions"}],"predecessor-version":[{"id":23416,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22685\/revisions\/23416"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=22685"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=22685"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=22685"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}