資格情報 Vault API を使用して、認証情報を作成、削除、検索、更新します。

権限

デフォルトでは、すべてのユーザーが資格情報を作成できます。現在のユーザーは自分が作成した資格情報の所有者になります。資格情報の所有者は、資格情報の所有権を更新、削除、転送することができます。

資格情報 URL

資格情報を作成
新規の資格情報を作成し、1 つ以上の属性を設定します。
POST http://<your_control_room_url>/v2/credentialvault/credentials
本文パラメーター:
フィールド 必須 説明:
name 必須 新しい資格情報名。最大 50 文字で、特殊文字を含めることはできません
description 任意。 新規の認証の説明。最大 255 文字
attributes
name 必須 新規の属性名。最大 50 文字で、特殊文字を含めることはできません
description 任意。 新規の属性の説明。最大 255 文字
userProvided 必須 次のオプションで入力タイプを設定します。
  • userProvided: true の場合、作成中に値はプリセットされません。この資格情報が含まれているロッカーのコンシューマーのみが、値を指定できます。
  • userProvided: false の場合、資格情報の所有者が値を入力します。すべてのコンシューマーには、資格情報の所有者によって設定された同じ属性の値が表示されます。
masked 任意。 値をマスクするかどうかを設定します。masked: false の場合、呼び出されたときに空の文字列として返されます。
passwordFlag 任意。 パスワード タイプ フィールドに使用を限定するパスワードとして値をフラグします。これにより、値がプレーン テキスト アプリケーションに印刷されないようにします。資格情報変数をサポートするコマンド

レスポンス: このレスポンスには、資格情報およびその属性に関する情報が含まれます。

{
  "id": "string",
  "name": "string",
  "description": "string",
  "lockerId": "string",
  "ownerId": "string",
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "userProvided": true,
      "masked": true,
      "passwordFlag": true,
      "createdBy": "string",
      "createdOn": "string",
      "updatedBy": "string",
      "updatedOn": "string",
      "version": "string"
    }
  ],
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "version": "string"
}
新しい資格情報の作成.
認証情報を作成した後、標準値を追加するには、資格情報属性に対する新しい値の割り当て を参照してください。
資格情報の検索
POST http://<your_control_room_url>/v2/credentialvault/credentials/list
クエリ パラメーター:
フィールド 必須 説明:
consumed 任意。 戻り値を現在のユーザーによって消費される資格情報だけにフィルターします。
本文パラメーター: このリクエスト本文の例には、応答を絞り込むためのフィルタ、ソート、ページ管理などが含まれています。
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}

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

フィルターを使用した資格情報の検索
ID ごとの資格情報の取得
GET http://<your_control_room_url>/v2/credentialvault/credentials/{id}
パス パラメーター:
フィールド 必須 説明:
id 必須 資格情報を特定します。

レスポンス: このレスポンスには、資格情報およびその属性に関する情報が含まれます。

{
  "id": "string",
  "name": "string",
  "description": "string",
  "lockerId": "string",
  "ownerId": "string",
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "userProvided": true,
      "masked": true,
      "passwordFlag": true,
      "createdBy": "string",
      "createdOn": "string",
      "updatedBy": "string",
      "updatedOn": "string",
      "version": "string"
    }
  ],
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "version": "string"
}
資格情報プロパティの更新
資格情報の所有者は、資格情報の名前または説明、属性の名前または説明、入力タイプ、値のマスキング、またはパスワード フラッグを変更できます。
注: ロッカーに既に割り当てられている資格情報を更新することはできません。この API で認証ID、資格情報の所有者、属性値、またはロッカーの割り当てを変更することはできません。代わりに、以下の API を使用します。
PUT http://<your_control_room_url>/v2/credentialvault/credentials/{id}
パス パラメーター:
フィールド 必須 説明:
id 必須 資格情報を特定します。
本文パラメーター:
フィールド 必須 説明:
name 必須 新しい資格情報名。最大 50 文字で、特殊文字を含めることはできません
description 任意。 新規の認証の説明。最大 255 文字
attributes
name 必須 新規の属性名。最大 50 文字で、特殊文字を含めることはできません
description 任意。 新規の属性の説明。最大 255 文字
userProvided 必須 次のオプションで入力タイプを設定します。
  • userProvided: true の場合、作成中に値はプリセットされません。この資格情報が含まれているロッカーのコンシューマーのみが、値を指定できます。
  • userProvided: false の場合、資格情報の所有者が値を入力します。すべてのコンシューマーには、資格情報の所有者によって設定された同じ属性の値が表示されます。
masked 任意。 値をマスクするかどうかを設定します。masked: false の場合、呼び出されたときに空の文字列として返されます。
passwordFlag 任意。 パスワード タイプ フィールドに使用を限定するパスワードとして値をフラグします。これにより、値がプレーン テキスト アプリケーションに印刷されないようにします。資格情報変数をサポートするコマンド

レスポンス: このレスポンスには、資格情報およびその属性に関する情報が含まれます。

{
  "id": "string",
  "name": "string",
  "description": "string",
  "lockerId": "string",
  "ownerId": "string",
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "userProvided": true,
      "masked": true,
      "passwordFlag": true,
      "createdBy": "string",
      "createdOn": "string",
      "updatedBy": "string",
      "updatedOn": "string",
      "version": "string"
    }
  ],
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "version": "string"
}
認証情報を更新する.
認証情報を削除する...
DELETE http://<your_control_room_url>/v2/credentialvault/credentials/{id}
パス パラメーター:
フィールド 必須 説明:
id 必須 資格情報を特定します。
レスポンス:
Successful delete
資格情報の所有者の更新
自分の資格情報を新しい所有者に転送することができます。資格情報がロッカーに割り当てられている場合、所有者をロッカーのメンバーに変更できます。資格情報がロッカーに割り当てられていない場合は、システム内の他のユーザーに所有権を転送できます。AAE_Locker ロールを持つユーザーは、システム内の認証情報の所有者を更新できます。
PUT http://<your_control_room_url>/v2/credentialvault/credentials/{id}/owner/{credentialOwnerId}
URL パラメーター:
フィールド 必須 説明:
id 必須 資格情報を特定します。
credentialOwnerId 必須 新しい所有者を指定します。
レスポンス:
Successful update of credential ownership