To retrieve the user details.
This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.
Method | POST |
Endpoint | https://{{host}}/api/public/usersInfo |
Content Type | application/json |
Authorization | auth: {{JWT}}
|
API Scope |
|
Path Parameters
Parameter | Description |
---|---|
host | Environment URL, for example, https://bots.kore.ai |
Sample Request
curl -X POST \ Â https://{{host}}/api/public/usersInfo \ Â -H 'Content-Type: application/json' \ Â -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ Â -d '{ Â Â Â "emailIds": [ Â Â Â Â Â Â Â "publicuser3@gmail.com", Â Â Â Â Â Â Â "test@test.com" Â Â Â ], Â Â Â "status":"active" }'
Body Parameters
Parameter | Description |
---|---|
emailIds | The array of email id’s for each user whose information is sought |
Status (optional) | Indicates the status of the user. Possible values:
|
Sample Response
- For success case:
[ Â Â Â { Â Â Â Â Â Â "canCreateBot": true, Â Â Â Â Â Â Â "isDeveloper": true, Â Â Â Â Â Â Â "userInfo": { Â Â Â Â Â Â Â Â Â Â Â "emailId": "publicuser3@gmail.com", Â Â Â Â Â Â Â Â Â Â Â "userId": "u-575f16b0-c4c5-5f3c-a740-06288c67dec1", Â Â Â Â Â Â Â Â Â Â Â "firstName": "", Â Â Â Â Â Â Â Â Â Â Â "lastName": "" Â Â Â Â Â Â Â Â Â Â Â "status": "active", Â Â Â Â Â Â Â Â Â Â Â "lastLogin": "2023-08-08T05:55:56.698Z" Â Â Â Â Â Â Â }, Â Â Â Â Â Â Â "roles": { Â Â Â Â Â Â Â Â Â Â Â "btRoles": [ Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleId": "5d9d920dabdc1e6e8ec99342", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleName": "sample bot role 2", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groups": [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botName": "bot6ent" Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â }, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleId": "5bb1ef53e6519fa9f722e69b", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleName": "Bot Tester", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groups": [ Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "group1" Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â ], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botId": "st-ac60188d-cdf4-5e58-a249-178e54cd85b7", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botName": "dashboardtest" Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â }, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleId": "5d9d8db30d54920a8df1e68b", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleName": "sample bot role1", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groups": [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botName": "bot5ent" Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â Â Â Â Â ], Â Â Â Â Â Â Â Â Â Â Â "adminRoles": [ Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleId": "5cd4081158217217cccabb7e", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleName": "admin", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groups": [] Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â }, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleId": "5d9d8d930d54920a8df1e689", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "roleName": "sample admin role1", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groups": [] Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â Â Â Â Â ] Â Â Â Â Â Â Â }, Â Â Â Â Â Â Â "assignBotTasks": [ Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "botId": "st-xxxxx-xxx-xxx-xxx-xxxxx", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "dialogs": [ Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "dg-xxxxx-xxx-xxx-xxx-xxxxx" Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â ], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "actions": [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "alerts": [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "knowledgeTask": [] Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â ], Â Â Â Â Â Â Â "groups": [ Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groupId": "e-06b41cdd-7678-5394-b958-40ca5662f502", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "groupName": "group1" Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â ] Â Â Â } ]
- Failure case:
[ Â Â Â { Â Â Â Â Â Â Â "userInfo": { Â Â Â Â Â Â Â Â Â Â Â "emailId": "a3q4", Â Â Â Â Â Â Â Â Â Â Â "status": "failure", Â Â Â Â Â Â Â Â Â Â Â "reason": { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "statusCode": 400, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "status": 400, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "customCode": 400, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "errors": [ Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â { Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "msg": "User not found. Please check the provided email address.", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "code": 400 Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â ], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "_headers": {}, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "message": "User not found. Please check the provided email address.", Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "name": "BadRequest" Â Â Â Â Â Â Â Â Â Â Â } Â Â Â Â Â Â Â } Â Â Â } ]