Lists a project's secrets#

プロジェクトのシークレットを一覧表示します。

APIエンドポイント#

リージョン	APIエンドポイント
西日本リージョン3の場合	https://keymanagement.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://keymanagement.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/secrets

HTTPステータスコード#

正常時：200

エラー時：401

リクエストパラメータの説明#

名前	In	Type	デフォルト値 /必須指定	Description
offset	path	integer	任意	表示するシークレットのリスト内の位置(オフセット値)
limit	path	integer	10 任意	表示する項目の最大数最大の指定可能値は100です。
name	path	string	任意	指定された値と同様の名前のシークレットに絞り込みます。
alg	path	string	任意	指定された値と同様のアルゴリズムのシークレットに絞り込みます。
mode	path	string	任意	指定された値と同様のモードのシークレットに絞り込みます。
bits	path	integer	任意	指定する値に一致するビット長のシークレットに絞り込みます。
secret_type	path	string	任意	指定されたタイプと同じシークレットを表示します。
acl_only	path	boolean	任意	操作ユーザーが存在するACLのシークレットを表示します。プロジェクトのスコープは無視されます。
created	path	string	任意	指定された日時に作成日時が一致するシークレットを表示します。詳細については、「Date Filters」を参照してください。
updated	path	string	任意	指定された日時に更新日時が一致するシークレットを表示します。詳細については、「Date Filters」を参照してください。
expiration	path	string	任意	指定する日時が一致する有効期限があるシークレットを表示します。詳細については、「Date Filters」を参照してください。
sort	path	string	任意	一覧表示のソート基準詳細については、「Sorting」を参照してください。

参考：Date Filters#

日時により情報を絞り込みます。

上記のcreated、updated、expirationの日時は、コンマで区切られるISO-8601形式の日時で指定してください。それぞれの日時の前に、gt: (greater-than、より大きい)、gte: (greater-than-or-equal、以上)、lt: (less-than, より少ない)、(lte: less-than-or-equal、以下)をプレフィックスとして指定することができます。

参考：Sorting#

一覧表示をソートします。

sortの属性はコンマで区切られるソートキーのリストとなります。有効なソートキーは, created, expiration, mode, name, secret_type, status, updatedなどがあります。

レスポンスボディ（正常系）の説明#

名前	Type	Description
secrets	list	シークレットのリスト各シークレットのオブジェクトの内容は、個別のシークレットの詳細を表示した場合と同じです。
total	integer	ユーザーが利用可能なシークレットの総数
next	string	limitとoffsetに基づいて動作する、次のシークレットの結果ページを表示するためのHATEOAS URL 一覧表示の項目数がoffsetとlimitの値より大きい場合に表示されます。
previous	string	offsetに基づいて動作する、1ページ前の結果ページを表示するためのHATEOAS URL offsetの値が1以上の場合に表示されます。

レスポンス例#

{
    "next": "http://{barbican_host}:9311/v1/secrets?limit=2&offset=3",
    "previous": "http://{barbican_host}:9311/v1/secrets?limit=2&offset=0",
    "secrets": [
        {
            "algorithm": null,
            "bit_length": null,
            "content_types": {
                "default": "application/octet-stream"
            },
            "created": "2015-04-07T03:37:19.805835",
            "creator_id": "3a7e3d2421384f56a8fb6cf082a8efab",
            "expiration": null,
            "mode": null,
            "name": "opaque octet-stream base64",
            "secret_ref": "http://{barbican_host}:9311/v1/secrets/{uuid}",
            "secret_type": "opaque",
            "status": "ACTIVE",
            "updated": "2015-04-07T03:37:19.808337"
        },
        {
            "algorithm": null,
            "bit_length": null,
            "content_types": {
                "default": "application/octet-stream"
            },
            "created": "2015-04-07T03:41:02.184159",
            "creator_id": "3a7e3d2421384f56a8fb6cf082a8efab",
            "expiration": null,
            "mode": null,
            "name": "opaque random octet-stream base64",
            "secret_ref": "http://{barbican_host}:9311/v1/secrets/{uuid}",
            "secret_type": "opaque",
            "status": "ACTIVE",
            "updated": "2015-04-07T03:41:02.187823"
        }
    ],
    "total": 5
}