OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Creating a Simple Bot
SKILLS
Storyboard
Dialog Task
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Overview
Configuring Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub-Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Versioning
Collaborative Development
PLAN & USAGE
Overview
Usage Plans
Support Plans
Invoices
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Creating a Simple Bot
Creating a Banking Bot
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
Update Balance Task
Transfer Funds Task
RELEASE NOTES
  1. ホーム
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Create User API

Create User API

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 URL, for example, https://bots.kore.ai

Body Parameters

Parameter Description
users The 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

userInfo.emailId
(mandatory)
Email Ids of the user being added
userInfo.orgUserId
(optional)
User id assigned by your organization of the user being added
userInfo.firstName
(optional)
First name of the user being added
userInfo.lastName
(optional)
Last name of the user being added
userInfo.companyName
(optional)
Company to which the user being added belongs
userInfo.dept
(optional)
Department to which the user being added belongs
userInfo.companyContactPhone
(optional)
Contact Phone of the Company to which the user being added belongs
userInfo.worknumber
(optional)
Work number of the user being added
userInfo.street
(optional)
Street Address of the user being added
userInfo.suiteNo
(optional)
Suite No Address of the user being added
userInfo.city
(optional)
City Address of the user being added
userInfo.zip
(optional)
Zip Address of the user being added
userInfo.state
(optional)
State Address of the user being added
userInfo.country
(optional)
Country Address of the user being added
groups
(optional)
array of group ids to which the user should belong
roles
(optional)
array of roleId-botId combinations saying what role the user has on which bot
assignBotTasks
(optional)
array of bots that need to be assigned to the user

botId Id of the Bot to be assigned 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”.
sendEmail
(optional)
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.
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 POST \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "deskkore1@gmail.com",
                "orgUserId": "org assigned user id",
                "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": [
                "e-06b41cdd-7678-5394-b958-40ca5662f502"
            ],
            "roles": [
                {
                    "roleId": "5d9d8db30d54920a8df1e68b",
                    "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                },
                {
                    "roleId": "5d9d920dabdc1e6e8ec99342",
                    "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                },
                {
                    "roleId": "5bbcb20c8bfd33db440ec1d1"
                },
                {
                    "roleId": "5d9d8d930d54920a8df1e689"
                }         
            ],
            "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 created Successfully"
        };
  • Failure case:
    {
        "failedUserDetails": [
            {
                "userInfo": {
                    "emailId": "deskkore1",
                    "firstName": "user1",
                    "status": "failure",
                    "reason": {
                        "statusCode": 400,
                        "status": 400,
                        "customCode": 400,
                        "errors": [
                            {
                                "msg": "INVALID_EMAIL",
                                "code": 400
                            }
                        ],
                        "_headers": {},
                        "message": "INVALID_EMAIL",
                        "name": "BadRequest"
                    }
                }
            }
    ]
    }
    
メニュー
Kore.ai Named a Leader in 2022 Gartner® Magic Quadrant™ for Enterprise Conversational AI PlatformsGet the Report