This API requires a JWT generated by an application created only from the Admin Console.
| Field | Value |
|---|---|
| Method | POST |
| Endpoint | https://{{host}}/api/public/usersInfo |
| Content Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token. |
| API Scope | App Builder: Not Applicable; Admin Console: User Management > User Management |
Path Parameters
| Parameter | Description |
|---|---|
host | Environment URL, for example, https://platform.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": [
"jane.doe@example.com",
"john.doe@example.com"
],
"status": "active",
"includeMeta": true
}'
Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
emailIds | Required | Array of Strings | The email IDs of the users whose information is sought. |
status | Optional | String | Filter by user status: active, not active, or all (default). |
includeMeta | Optional | Boolean | Set to true for encrypted response. Default: False. |
Sample Response
Success:[
{
"canCreateBot": true,
"isDeveloper": true,
"moreAvailable": true,
"total": 2,
"userInfo": {
"emailId": "john.doe@example.com",
"userId": "u-575f16b0-c4c5-5f3c-a740-06288c6xxxxx",
"firstName": "",
"lastName": "",
"status": "active",
"lastLogin": "2023-08-08T05:55:56.698Z"
},
"roles": {
"btRoles": [
{
"roleId": "5d9d920dabdc1e6e8ec99342",
"roleName": "sample bot role 2",
"botId": "st-16511425-15c5-5cdf-b652-a796db7xxxxx",
"botName": "bot6ent"
}
],
"adminRoles": [
{
"roleId": "5cd4081158217217cccxxxxx",
"roleName": "admin"
}
]
},
"groups": [
{
"groupId": "e-06b41cdd-7678-5394-b958-40ca566xxxxx",
"groupName": "group1"
}
]
}
]
[
{
"userInfo": {
"emailId": "a3q4",
"status": "failure",
"reason": {
"errors": [
{
"msg": "User not found. Please check the provided email address.",
"code": 400
}
]
}
}
}
]
Response Parameters
| Parameter | Type | Description |
|---|---|---|
moreAvailable | Boolean | Indicates if more records are available for retrieval. |
total | Optional | The total count of available records. |