アカウントにユーザーを追加します。
この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" } } } ] }