Device KVS一覧の取得¶

ネームスペースにあるDevice KVSの一覧を取得します。

※ネームスペースは、APIキーのネームスペースになります。

APIキーに必要な権限¶

DKVS : LIST

メソッド¶

GET

URL¶

/v1/dkvs

URLパラメータ¶

パラメータ名	型	内容
sort_field	文字列	ソートするフィールド名(device_id, device_type, key, value, created_at)。デフォルトはcreated_at。
sort_order	文字列	ソートの並び。desc(デフォルト) または asc。
page_index	数値	現在のページ。デフォルトは1。
page_size	数値	1ページあたりの件数。デフォルトは20。最大50。
device_id	文字列	検索条件。デバイスID。
device_type	数値	検索条件。デバイスの種類。 0: YubiKey 1: OATH 2: FIDO 3: NJS ATKey
key	文字列	検索条件。KVSのKey。
value	文字列	検索条件。KVSのValue。
created_at	文字列	検索条件。作成日付 ('YYYY-MM-DD')。

検索条件に正規表現は使用できません。
検索条件は部分一致です。
検索はAND検索です。

リクエスト例¶

curl \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  "https://api.d-auth.com/v1/dkvs?sort_order=asc&device_id=efkei"

<API-KEY> : 使用するAPIキー

レスポンス例¶

ステータスライン / レスポンスヘッダ¶

HTTP/1.1 200 OK 
Content-Type:application/json;charset=utf-8

レスポンスボディ¶

[
    items: [
        {
            "key": "key1234",
            "device_type": 0,
            "device_id": "xxxxxxxxxxxx",
            "value": {
                "name": "xxxx"
            },
            "created_at": "2020-10-30 10:10:00"
        },
        ...
    ],
    item_count: 20

items : DKVSの情報
item_count: 検索結果の全件数

エラーレスポンス¶

詳細はこちらをご参照ください。