사용자 세부 정보를 검색합니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.
POSThttps://{{host}}/api/public/usersInfo
참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.
사용자 세부 정보를 검색합니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.
POSThttps://{{host}}/api/public/usersInfo
참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.
매개 변수 | 설명 |
---|---|
host | 환경 URL(예: https://bots.kore.ai) |
매개 변수 | 설명 |
---|---|
emailIds 또는 orgUserIds | 정보를 찾는 각 사용자의 이메일 또는 조직 사용자 ID의 배열 |
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
application/json
curl -X POST \
https://{{host}}/api/public/usersInfo \
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
"emailIds"/"orgUserIds": [
"publicuser3@gmail.com",
"test@test.com"
]
}'
[ { "canCreateBot": true, "isDeveloper": true, "userInfo": { "emailId": "publicuser3@gmail.com", "userId": "u-575f16b0-c4c5-5f3c-a740-06288c67dec1", "firstName": "", "lastName": "" }, "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" } ] }, { "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } } ]
{ "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } }
ユーザーの詳細を取得します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。
POST https://{{host}}/api/public/usersInfo
注意:この機能は、プラットフォームのバージョン7.1で導入されました。
パラメータ | 説明 |
---|---|
ホスト | 環境URL(例: https://bots.kore.ai) |
パラメータ | 説明 |
---|---|
emailIdsまたはorgUserIds | 情報が求められる各ユーザーのemailまたはorgのユーザーIDの配列 |
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
application/json
curl -X POST \ https://{{host}}/api/public/usersInfo \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "emailIds"/"orgUserIds": [ "publicuser3@gmail.com", "test@test.com" ] }'
[ { "canCreateBot": true, "isDeveloper": true, "userInfo": { "emailId": "publicuser3@gmail.com", "userId": "u-575f16b0-c4c5-5f3c-a740-06288c67dec1", "firstName": "", "lastName": "" }, "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" } ] }, { "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } } ]
{ "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } }
To retrieve the 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.
POST https://{{host}}/api/public/usersInfo
NOTE: This feature was introduced in ver7.1 of the platform.
Parameter | Description |
---|---|
host | Environment URL, for example, https://bots.kore.ai |
Parameter | Description |
---|---|
emailIds
or orgUserIds |
The array of email or org user id for each user whose information is sought |
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
application/json
curl -X POST \
https://{{host}}/api/public/usersInfo \
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
"emailIds"/"orgUserIds": [
"publicuser3@gmail.com",
"test@test.com"
]
}'
[ { "canCreateBot": true, "isDeveloper": true, "userInfo": { "emailId": "publicuser3@gmail.com", "userId": "u-575f16b0-c4c5-5f3c-a740-06288c67dec1", "firstName": "", "lastName": "" }, "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" } ] }, { "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } } ]
{ "userInfo": { "emailId": "test@test.com", "status": "failure", "reason": "Invalid emailId" } }