鍵情報の一覧取得 (GET /v1/{tenant_id}/secrets)

鍵情報の一覧を取得する。

{tenant_id}: 鍵情報を取得するプロジェクトのID

Request Headers

X-Auth-Token

認証トークンIDを指定する。

Data Type Cardinality
String 1..1

Request Parameter

limit

一度に表示するリソースの数（省略時は10）

Data Type Cardinality
int 0..1

offset

表示するリソースの開始位置（省略時は0）

Data Type Cardinality
int 0..1

Request Body

なし

Response Headers

ステータス

リクエストのステータスを返却する。

以下の値を返却する。

200：
正常終了
401：
認証エラー（認証トークン無し、認証トークン誤り等）
400：
不正なアクセス（パラメーター不正等）
403：
アクセス不可(権限がない)
404：
該当資源なし
500：
予期せぬエラー
Data Type Cardinality
int 1..1

Response Elements

secrets

鍵情報一覧のエンベロープ

Data Type Cardinality Parent Element Child Element(s)
Element 1..1 None (secret)

(secret) ※json上のElement nameは無し

鍵情報のエンベロープ

Data Type Cardinality Parent Element Child Element(s)
Element 0..* secrets name

status

algorithm

mode

bit_length

content_types

expiration

secret_ref

updated

created

name

鍵情報の名前

Data Type Cardinality Parent Element Child Element(s)
String 1..1 (secret) None

status

鍵情報の状態

Data Type Cardinality Parent Element Child Element(s)
Enum(ACTIVE,ERROR) 1..1 (secret) None

algorithm

鍵情報生成時に利用するアルゴリズム

Data Type Cardinality Parent Element Child Element(s)
String 1..1 (secret) None

mode

鍵情報に関連づいたアルゴリズムのモード

Data Type Cardinality Parent Element Child Element(s)
String 1..1 (secret) None

bit_length

鍵情報のビットレンジ

Data Type Cardinality Parent Element Child Element(s)
int 1..1 (secret) None

content_types

payloadの参照に必要なAcceptヘッダー値

Data Type Cardinality Parent Element Child Element(s)
String 0..1 (secret) None

expiration

鍵情報の有効期限。ISO-8601で規定された値。期限が過ぎると鍵情報は自動的に削除される。nullの場合、期限なし（自動で削除されない）

Data Type Cardinality Parent Element Child Element(s)
String 1..1 (secret) None

secret_ref

鍵情報リソースURI

Data Type Cardinality Parent Element Child Element(s)
String 1..1 (secret) None

updated

最終更新時のタイムスタンプ(UTC)

Data Type Cardinality Parent Element Child Element(s)
datetime 1..1 (secret) None

created

作成時のタイムスタンプ(UTC)

Data Type Cardinality Parent Element Child Element(s)
datetime 1..1 (secret) None

total

プロジェクトに登録されている鍵情報の数

Data Type Cardinality Parent Element Child Element(s)
int 1..1 None None

previous

取得した鍵情報一覧の前の鍵情報リソースオフセット情報

Data Type Cardinality Parent Element Child Element(s)
String 0..1 None None

next

取得した鍵情報一覧の後の鍵情報リソースオフセット情報

Data Type Cardinality Parent Element Child Element(s)
String 0..1 None None

Example of Request


GET /v1/a759452216fd41cf8ee5aba321cfbd49/secrets?limit=2&offset=3
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."

Example of Response


Status Code: 200 OK
Content-Length: 2446
Content-Type: application/json; charset=UTF-8

{
  "secrets": [
    {
      "status": "ACTIVE",
      "secret_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/82b63ed0-3ec7-4f3c-93b6-dde9a3c81b99",
      "updated": "2014-07-15T06:04:23.502093",
      "name": "key1",
      "algorithm": null,
      "created": "2014-07-15T06:04:23.490168",
      "content_types": {
        "default": "text/plain"
      },
      "mode": null,
      "bit_length": null,
      "expiration": "2015-02-28T19:14:44.180394"
    },
  "total": 20,
  "next": http://<host>:9311/v1/ a759452216fd41cf8ee5aba321cfbd49/secrets?limit=1&offset=3,
  "previous": http://<host>:9311/v1/ a759452216fd41cf8ee5aba321cfbd49/secrets?limit=1&offset=1
}