ユーザーの詳細を更新します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。
入力 https://{{host}}/api/public/users 注意：この機能は、プラットフォームのバージョン7.1で導入されました。
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例： https://bots.kore.ai） |
本文パラメータ
| パラメータ | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | 更新する必要のある各ユーザーの詳細の配列
|
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X PUT \ https://{{host}}/api/public/users \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "users": [ { "userInfo": { "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>, "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": { "addTo": [ "e-f9c09c08-9310-52ff-b672-570ec7325215" ] }, "roles": { "addTo": [ { "roleId": "5d9d8db3x0d54920a8df1e68b", "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733" } ], "removeFrom": [ { "roleId": "5d9d920dabdc1e6e8ec99342", "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b" } ] }, "assignBotTasks": [ { "botId": "st-xxx-xx-xxx-xxx-xxxx", "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"] } ], "canCreateBot": true, "isDeveloper": true } ] } '
サンプル応答
-
- 成功例：
{ "msg": "ユーザーが正常に更新されました" };
- 成功例：