特定のロールを検索する

特定のロールを返す API を使用して、Control Room に含まれる特定のロールを取得します。

前提条件

ロールを表示
ロールの表示権限を持っているユーザーは、特定のロールの詳細を取得できます。
JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
  • URL: http://<your_control_room_url>/v1/usermanagement/roles/{ID}
  • メソッド GET
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. GET メソッドを選択します。
  3. リクエスト URL で、取得するロール ID を追加します。
    GET http://<your_control_room_url>/v1/usermanagement/roles/17
    • REST Client で SEND をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文:

    {
  "id": 17,
  "createdBy": 4,
  "createdOn": "2019-11-20T18:26:37Z",
  "updatedBy": 4,
  "updatedOn": "2019-11-20T18:26:37Z",
  "tenantId": 1,
  "version": 0,
  "status": "Active",
  "description": "Created a Role for Bot running",
  "name": "DocBotRoleMD1",
  "accessRestriction": null,
  "permissions": [{
    "id": 134,
    "createdBy": 0,
    "createdOn": "2019-12-05T00:03:05Z",
    "updatedBy": 0,
    "updatedOn": "2019-12-05T00:03:05Z",
    "tenantId": 1,
    "version": 0,
    "status": null,
    "action": "viewuserbasic",
    "resourceId": null,
    "resourceType": "usermanagement"
  }],
  "countPrincipals": 0,
  "principals": [{
    "id": 16,
    "createdBy": 4,
    "createdOn": "2019-11-22T20:52:35Z",
    "updatedBy": 4,
    "updatedOn": "2019-11-22T20:52:35Z",
    "tenantId": 1,
    "version": 0,
    "status": "Active",
    "username": "docs_md_admin",
    "description": "Created a user with admin rights",
    "deleted": false,
    "disabled": false,
    "email": "aamd@md.com",
    "firstName": "Docs_AAMD1",
    "lastName": "Docs_AAMD1",
    "autoLoginEnabled": true,
    "emailVerified": true,
    "clientRegistered": false,
    "passwordSet": false,
    "questionsSet": false,
    "activeDirectory": false
  }]
}
    パラメーター名 説明:
    id システム生成によるロール ID 番号。
    "createdBy": 新規ユーザーを作成した管理者ユーザーのシステム生成によるユーザー ID。
    updatedBy ロールを更新した管理者ユーザーのシステム生成によるユーザー ID。
    tenantID アクティブ ユーザーのシステム生成による ID 番号。
    version 新規ロールのシステム生成によるバージョン番号。役割が更新されるたびに、バージョン番号が増加します。
    accessRestriction 特定のロールのアクセス制限をリストします。
    権限 ロール権限をリストします。
    countPrincipals Active Directory のプリンシパル ユーザーの合計数。
    principals Active Directory のプリンシパル ユーザーをリストします。
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X GET "http://<your_control_room_url>/v1/usermanagement/roles/31" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{17}"