特定のユーザーを検索する

使用の詳細を取得 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 に置き換えます。

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

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. GET メソッドを選択します。
  3. リクエスト ヘッダーで、検索する特定のユーザー ID を追加します。
    GET http://<your_control_room_url>/v1/usermanagement/users/35
  4. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。
    レスポンス本文:
    {
  "id": 35,
  "email": "aa@aa.com",
  "username": "docbotusermd100",
  "domain": "ActiveDirectory (LDAP)",
  "firstName": "AAMHD4",
  "lastName": "AAMHD5",
  "version": 0,
  "principalId": 35,
  "deleted": false,
  "roles": [{
    "name": "DocBotRole03",
    "id": 18,
    "version": 0
  }],
  "sysAssignedRoles": [],
  "groupNames": [],
  "permissions": [{
    "id": 134,
    "action": "viewuserbasic",
    "resourceId": null,
    "resourceType": "usermanagement"
  }],
  "licenseFeatures": ["DEVELOPMENT"],
  "emailVerified": true,
  "passwordSet": false,
  "questionsSet": false,
  "enableAutoLogin": true,
  "disabled": false,
  "clientRegistered": false,
  "description": "Created a user for running bots",
  "createdBy": 4,
  "createdOn": "2019-12-16T23:00:58Z",
  "updatedBy": 4,
  "updatedOn": "2019-12-16T23:00:58Z",
  "publicKey": null,
  "appType": null,
  "routingName": null,
  "appUrl": null
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X GET "http://<your_control_room_url>/v1/usermanagement/users/11" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{35}"