ロッカーの管理

資格情報 Vault API を使用して、ロッカー、コンシューマー、メンバー、およびロッカー内の認証情報を管理します。

権限

AAE_Locker_Admin ロールを持つユーザーは、すべてのロッカーを表示して管理できます。デフォルトでは、管理者以外のユーザーは自分のロッカーを作成して管理する権限を持っています。他のロッカーにアクセスする権限を管理者以外のユーザーに与えることもできます。
ロッカー管理に関連するロールと権限は次のとおりです。

  • ロッカー所有者: ロッカー所有者は、ロッカーの編集、表示、削除、ならびに他の所有者の追加または削除を行うことができます。

  • ロッカー管理者: ロッカー管理者は、ロッカー所有者のすべての機能にアクセスできますが、所有者、管理者、または参加者をロッカーに追加することはできません。

  • ロッカー参加者: ロッカー参加者はロッカーを表示できます。ロッカー参加者は、各自の資格情報をロッカーに追加することもできます。ロッカー参加者は、他のユーザーが作成した資格情報にアクセスしたり、表示したりすることはできません。

  • ロッカー コンシューマー: ロッカー利用者は、ロッカーを表示し、資格情報の属性値を入力できます (属性がユーザーによる入力用に構成されている場合)。1 つ以上のユーザー定義ロールを選択する場合、これらの選択されたロールを持つユーザーがロッカーの利用者になります。

ロッカーの URL

ロッカー の新規インスタンスの作成
POST http://<your_control_room_url>/v2/credentialvault/lockers
本文パラメーター:
フィールド 必須 説明: 注記
名前 必須 新規ロッカーの名前 文字列 (最大 50 文字) 。特殊文字を含めることはできません
description 任意。 新規ロッカーの説明 文字列 (最大 255 文字)
レスポンス本文: このレスポンス本文には、新しい ロッカー に関する情報が含まれています。
{
  "id": "lockerIdNumber",
  "name": "lockerName",
  "description": "lockerDescription",
  "createdBy": "userIdNumber",
  "createdOn": "dateTime",
  "updatedBy": "userIdNumber",
  "updatedOn": "dateTime",
  "version": "numberOfTimesUpdated"
}
ロッカーの新規作成の一環として、次の URL を使用します。
ロッカー の検索する
ユーザーがメンバー (所有者、マネージャー、または参加者) であるロッカーのリスト、または使用権限 (コンシューマー) を返します。ユーザーが AAE_Locker 管理者権限を持っている場合、この URL はシステム内のすべてのロッカーのリストを返します。
POST http://<your_control_room_url>/v2/credentialvault/lockers/list
本文パラメーター: このリクエスト本文の例には、応答を絞り込むためのフィルタ、ソート、ページ管理などが含まれています。
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}

フィルターを使用することで、レスポンス本文に返された内容を絞り込むことができます。フィルターについての詳細は、「API リクエスト本文でフィルタリング」をご覧ください。

レスポンス本文: このレスポンス本文には、ロッカーに関する情報が含まれています。また、各 ロッカー のメンバーとその権限、資格情報件数も返されます。
{
  "page": {
    "offset": 0,
    "total": 0,
    "totalFilter": 0
  },
  "list": [
    {
      "id": "lockerIdNumber",
      "name": "lockerName",
      "description": "lockerDescription",
      "createdBy": "userIdNumber",
      "createdOn": "dateTime",
      "updatedBy": "userIdNumber",
      "updatedOn": "dateTime",
      "version": "numberOfTimesUpdated",
      "members": [
        {
          "id": "userIdNumber",
          "permissions": [
            "participate/own/manage/consume"
          ]
        }
      ],
      "countOfCredentials": numberOfCredentialsInLocker
    }
  ]
}
検索の例:フィルターを使用したロッカーの検索
ID 別の特定のロッカーの取得
GET http://<your_control_room_url>/v2/credentialvault/lockers/{id}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
レスポンス本文: 
{
  "id": "lockerIdNumber",
  "name": "lockerName",
  "description": "lockerDescription",
  "createdBy": "userIdNumber",
  "createdOn": "dateTime",
  "updatedBy": "userIdNumber",
  "updatedOn": "dateTime",
  "version": "numberOfTimesUpdated"
}
既存のロッカーの更新
PUT http://<your_control_room_url>/v2/credentialvault/lockers/{id}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列

本文パラメーター: このリクエスト本文には、更新できるすべてのフィールドが含まれています。

フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
名前 必須 ロッカー名を確認または更新します。 文字列
description 任意。 ロッカーを説明します。 文字列
createdBy 任意。 ID 別に作成者を特定します。 文字列
createdOn 任意。 YYYY-MM-DD HH:MM:SS.MS 日付/時刻:
updatedBy 任意。 最後にロッカーを変更したユーザーを ID で特定します 文字列
updatedOn 任意。 YYYY-MM-DD HH:MM:SS.MS 日付/時刻:
version 任意。 ロッカーが更新された回数を表します。 数字
レスポンス本文: このレスポンス本文には、更新されたロッカーに関する情報が含まれています。
{
  "id": "lockerIdNumber",
  "name": "lockerName",
  "description": "lockerDescription",
  "createdBy": "userIdNumber",
  "createdOn": "dateTime",
  "updatedBy": "userIdNumber",
  "updatedOn": "dateTime",
  "version": "numberOfTimesUpdated"
}
ロッカー の削除
DELETE http://<your_control_room_url>/v2/credentialvault/lockers/{id}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列

ロッカー コンシューマー URL

これらの URL は、ユーザー ID ではないロールを受け入れます。ロール API を使用してロールを管理します。「ユーザー管理 API の概要」をご覧ください。

ロッカーのコンシューマーのリストの取得
GET http://<your_control_room_url>/v2/credentialvault/lockers/{id}/consumers
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
レスポンス本文: このレスポンスには、ロッカー 内の資格情報にアクセスできるすべてのロールのリストが含まれます。
{
  "list": [
    {
      "id": "roleIdNumber"
    }
  ]
}
ロッカーへのコンシューマーの追加
POST http://<your_control_room_url>/v2/credentialvault/lockers/{id}/consumers
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
本文パラメーター:
フィールド 必須 説明: 注記
id 必須 ロールを特定します。 文字列
特定のロッカーからのコンシューマーの削除
DELETE http://<your_control_room_url>/v2/credentialvault/lockers/{id}/consumers/{roleId}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
roleId 必須 ロールを特定します。 文字列

ロッカー メンバーの URL

ロッカー メンバーのリストの取得
GET http://<your_control_room_url>/v2/credentialvault/lockers/{id}/members
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
レスポンス本文: レスポンスには、すべてのロッカー メンバーとその権限 (参加、管理、または所有) リストが含まれます。
{
  "list": [
    {
      "id": "userIdNumber",
      "permissions": [
        "participate/manage/own"
      ]
    }
  ]
}
ロッカー のメンバーの追加または更新
PUT http://<your_control_room_url>/v2/credentialvault/lockers/{id}/members/{userId}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
userId 必須 ユーザーを特定します。 文字列
本文パラメーター:
フィールド 必須 説明: 注記
"permissions": 必須 可能な値: participate (参加)、manage (管理)、own (所有)

資格情報 Vault 資格情報の管理のための RBAC.

 文字列
ロッカーからのメンバーの削除
DELETE http://<your_control_room_url>/v2/credentialvault/lockers/{id}/members/{userId}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
userId 必須 ユーザーを特定します。 文字列

ロッカー資格情報 URL

ロッカーのすべての認証情報のリストの取得
GET http://<your_control_room_url>/v2/credentialvault/lockers/{id}/credentials
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
レスポンス本文: レスポンスには、現在のユーザーの権限に基づいて、ロッカーに属するすべての資格情報とその属性のリストが含まれます。
{
  "list": [
    {
      "id": "credentialIdNumber",
      "name": "credentialName",
      "description": "credentialDescription",
      "completed": true/false,
      "lockerId": "lockerIdNumber",
      "ownerId": "userIdNumber",
      "attributes": [
        {
          "id": "attributeIdNumber",
          "name": "attributeName",
          "description": "attributeDescription",
          "userProvided": true/false,
          "masked": true/false,
          "passwordFlag": true/false,
          "createdBy": "userIdNumber",
          "createdOn": "dateTime",
          "updatedBy": "userIdNumber",
          "updatedOn": "dateTime",
          "version": "numberOfTimesUpdated"
        }
      ],
      "createdBy": "userIdNumber",
      "createdOn": "dateTime",
      "updatedBy": "userIdNumber",
      "updatedOn": "dateTime",
      "version": "numberOfTimesUpdated"
    }
  ]
}
ロッカーへの資格情報の追加
注: ロッカーの所有者、マネージャー、または参加者である必要があります。
PUT http://<your_control_room_url>/v2/credentialvault/lockers/{id}/credentials/{credentialId}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
credentialId 必須 資格情報を特定します。 文字列
ロッカーからの資格情報の削除
注: ロッカーの所有者、マネージャー、または参加者である必要があります。
DELETE http://<your_control_room_url>/v2/credentialvault/lockers/{id}/credentials/{credentialId}
パス パラメーター:
フィールド 必須 説明: 注記
id 必須 ロッカー を特定します。 文字列
credentialId 必須 資格情報を特定します。 文字列