既存のロールを更新

既存のロールを更新 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}

    角括弧内のコンテンツを 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. リクエスト URL で、更新するロール ID を追加します。
    PUT http://<your_control_room_url>/v1/usermanagement/roles/37

    リクエスト本文:

     {
  "id": null,
  "name": "viewRoles-Docs1",
  "accessRestriction": null,
  "permissions": [{
    "id": 59,  
    "action": "ManageCredentials",
    "resourceId": null,
    "resourceType": "credentials"
  },  {
    "id": 134,
    "action": "ViewUserBasic",
    "resourceId": null,
    "resourceType": "UserManagement"
  }],
  "countPrincipals": 0,
  "principals": [{
    "id": 21
  }]
}
  4. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。

    レスポンス本文:

    {
  "id": 37,
  "createdBy": 4,
  "createdOn": "2019-12-17T03:24:22Z",
  "updatedBy": 36,
  "updatedOn": "2019-12-18T00:13:27Z",
  "tenantId": 1,
  "version": 20,
  "status": "Active",
  "description": null,
  "name": "viewRoles-Docs1",
  "accessRestriction": null,
  "permissions": [{
    "id": 59,
    "createdBy": 0,
    "createdOn": "2019-10-03T23:53:47Z",
    "updatedBy": 0,
    "updatedOn": "2019-10-03T23:53:47Z",
    "tenantId": 1,
    "version": 0,
    "status": null,
    "action": "managecredentials",
    "resourceId": null,
    "resourceType": "credentials"
  }, {
    "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": 21,
    "createdBy": 4,
    "createdOn": "2019-11-24T17:41:37Z",
    "updatedBy": 4,
    "updatedOn": "2019-12-17T03:25:47Z",
    "tenantId": 1,
    "version": 11,
    "status": "Active",
    "username": "docs-bot",
    "description": "Basic bot and MetaBot designer",
    "deleted": false,
    "disabled": false,
    "email": "tm@aa.com",
    "firstName": "",
    "lastName": "",
    "autoLoginEnabled": false,
    "emailVerified": true,
    "clientRegistered": true,
    "passwordSet": true,
    "questionsSet": true,
    "activeDirectory": false
  }]
}
    パラメーター名 説明:
    id システム生成によるロール ID 番号。
    "createdBy": ロールを作成した管理者ユーザーのシステム生成によるロール ID 番号。
    updatedBy ロールを更新した管理者ユーザーのシステム生成によるロール ID 番号。
    tenantID アクティブ ユーザーのシステム生成による ID 番号。
    version 新規ロールのシステム生成によるバージョン番号。役割が更新されるたびに、バージョン番号が増加します。
    ステータス 既存のロール状態: アクティブまたは無効。
    accessRestriction 特定のロールのアクセス制限をリストします。
    権限 ロール権限をリストします。
    countPrincipals Active Directory プリンシパル ユーザーの合計数。
    principals Active Directory プリンシパル ユーザーをリストします。
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X PUT "http://<your_control_room_url>/v1/usermanagement/roles/37" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "'{
  "id": null,
  "name": "viewRoles-Docs1",
  "accessRestriction": null,
  "permissions": [{
    "id": 59,  
    "action": "ManageCredentials",
    "resourceId": null,
    "resourceType": "credentials"
  },  {
    "id": 134,
    "action": "ViewUserBasic",
    "resourceId": null,
    "resourceType": "UserManagement"
  }],
  "countPrincipals": 0,
  "principals": [{
    "id": 21
  }]
}'