既存のユーザーを更新

ユーザーの詳細を更新 API を使用して、Control Room にある既存のユーザー情報を更新します。

前提条件

ユーザー編集の権限
ユーザー編集の権限を持っているユーザーは、特定のユーザー詳細を更新できます。
JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
  • URL: http://<your_control_room_url>/v1/usermanagement/users{ID}

    角括弧内のコンテンツを Control Room の URL に置き換えます。

  • メソッド: PUT
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. [POST] メソッドを選択します。
  3. リクエスト ヘッダーで、更新する既存のユーザー ID を追加します。更新するユーザー ID を検索するには、ユーザーの検索 API を実行します。
    PUT http://<your_control_room_url>/v1/usermanagement/users/27

    リクエスト本文で、必須パラメータを追加します。

    パラメーター名 必須パラメーター タイプ 説明:
    ユーザー名: はい 文字列 (最大 255 文字) 新規ユーザー名
    E メール: はい 文字列 には、a@a.com などの @ 記号を含める必要があります。 新規ユーザーの E メール
    ロール: 名前 はい 文字列 (最大 255 文字) ロールの新しい名前

    リクエスト本文:

    { 
    "username": "docsusermd2",
    "domain": "",
    "firstName": "DocsUserMHD1",
    "lastName": "DocUserMHD2",
    "version": 2,
    "principalId": 27,
    "email": "aamd@aa.com",  
    "description": "Created a user to create other roles and users", 
    "createdOn": "2019-11-26T23:44:12.937Z", 
    "updatedOn": "2019-11-26T23:51:39.163Z",  
    "roles": [{
      "id": 27,
      "name": "RoleBotDocsMD6",
      "version": "0"
    }],
    "deleted": false
  }
  4. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。

    レスポンス本文:

    
{
  "id": 27,
  "email": "aamd@aa.com",
  "username": "docsusermd",
  "domain": null,
  "firstName": "DocsUserMHD1",
  "lastName": "DocUserMHD2",
  "version": 6,
  "principalId": 27,
  "deleted": false,
  "roles": [{
    "name": "RoleBotDocsMD6",
    "id": 27,
    "version": 0
  }],
  "sysAssignedRoles": [],
  "groupNames": [],
  "permissions": [],
  "licenseFeatures": [],
  "emailVerified": true,
  "passwordSet": true,
  "questionsSet": true,
  "enableAutoLogin": false,
  "disabled": false,
  "clientRegistered": false,
  "description": "Created a user to create other roles and users",
  "createdBy": 4,
  "createdOn": "2019-11-26T23:44:12Z",
  "updatedBy": 4,
  "updatedOn": "2019-12-02T23:31:25Z",
  "publicKey": null,
  "appType": null,
  "routingName": null,
  "appUrl": null
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X PUT "http://<your_control_room_url>/v1/usermanagement/users/27" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "'{
    "username": "docsusermd2",
    "domain": "",
    "firstName": "DocsUserMHD1",
    "lastName": "DocUserMHD2",
    "version": 2,
    "principalId": 27,
    "email": "aamd@aa.com",  
    "description": "Created a user to create other roles and users", 
    "createdOn": "2019-11-26T23:44:12.937Z", 
    "updatedOn": "2019-11-26T23:51:39.163Z",  
    "roles": [{
      "id": 27,
      "name": "RoleBotDocsMD6",
      "version": "0"
    }],
    "deleted": false
  }'