계정에 사용자를 추가합니다
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.
POSThttps://{{host}}/api/public/users 참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL(예: https://bots.kore.ai) |
본문 매개 변수
| 매개 변수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users |
각 사용자에 대한 세부 정보 배열에는 사용자 이메일 ID, 사용자 이름, 사용자가 속할 그룹, 봇에 할당될 역할 및 권한이 포함됩니다
|
||||||||||||||||||||||||||||||||||||||||||
| sendEmail(선택 사항) | 계정 아래 사용자를 활성화하기 위해 활성화 링크를 포함한 사용자에게 이메일을 보내야 하는지를 결정합니다. true 또는 false로 설정합니다. 기본값은 "true"입니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
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
}
]
}'
샘플 응답
- 성공 사례의 경우:
{ "msg": "Users are created Successfully" }; - 실패 사례:
{ "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" } } } ] }
アカウントにユーザーを追加します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。
POST https://{{host}}/api/public/users 注意：この機能は、プラットフォームのバージョン7.1で導入されました。
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例： https://bots.kore.ai） |
本文パラメータ
| パラメータ | 説明 | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | ユーザーのメールID、ユーザーの名、ユーザーが属するグループ、ボットに割り当てられるロール、およびアクセス許可を含む、各ユーザーの詳細の配列です。
|
||||||||||||||||||||||||||||||||||||||||||
| sendEmail（任意） | アカウントのユーザーを有効化するために、有効化リンクを含むメールをユーザーに送信する必要があるかどうかを判断します。TrueまたはFalseを設定します。デフォルト値は"True"です。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
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 } ] }'
サンプル応答
- 成功例：
{ "msg": "Users are created Successfully" }; - 失敗例：
{ "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" } } } ] }
Leave a Reply
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
|
||||||||||||||||||||||||||||||||||||||||||
| 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" } } } ] }