コンテンツにスキップ

FIDO認証器一覧の取得

ネームスペースにあるFIDO認証器の一覧を取得します。

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

APIキーに必要な権限

FIDO : LIST

メソッド

GET

URL

/v1/fido

URLパラメータ

パラメータ名 必須 内容
sort_field 文字列 ソートするフィールド名(credential_id, device_id, device_name, user_id, is_enabled, created_at)。デフォルトはcreated_at。
sort_order 文字列 ソートの並び。desc(デフォルト) または asc。
page_index 数値 現在のページ。デフォルトは1。
page_size 数値 1ページあたりの件数。デフォルトは20。最大50。
credential_id 文字列 検索条件。個体識別番号。
device_id 文字列 検索条件。デバイスID。
device_name 文字列 検索条件。デバイス名。
user_id 文字列 検索条件。ユーザID。
is_enabled 真偽値 検索条件。有効かどうか。
created_at 文字列 検索条件。作成日付 ('YYYY-MM-DD')。タイムゾーンはUTC。
updated_at 文字列 検索条件。情報更新日時 ('YYYY-MM-DD')。タイムゾーンはUTC。
unused_days 数値 未使用期間。デフォルトは未指定(未使用期間の検索は行わない)。最大9999。FIDO認証器が使用されていない日数。
※未使用期間の検索は、デバイス情報の編集や認証など、最終的に情報を更新した日時を元に検索します。
  • 検索条件に正規表現は使用できません。
  • 検索条件は部分一致です。

リクエスト例

curl \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  "https://api.d-auth.com/v1/fido?sort_order=asc&user_id=xxxxxxx"
  • <API-KEY> : 使用するAPIキー

レスポンス例

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

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

レスポンスボディ

 {
    "items": [
        {
            "credential_id": "IFGeJngCMfA4cNx2jhseoDigGkzbGcIFGeJngTEb3qhKHqIKIdNCC0ef2cbKTqRoJmkHA0EooOAnj/HMhngTA==",
            "device_id": "00000000-03df-4aa1-a0e0-ebcb4785cae7",
            "user_id": "hoge@test.com",
            "created_at": "2022/04/13 23:51:40",
            "updated_at": "2022/04/13 23:51:40",
            "device_name": "fido device",
            "is_enabled": true
        },
        ...
    ],
    "item_count": 10,
} 
  • items : FIDO認証器の情報
    • credential_id : navigaterオブジェクトとfido認証器間で参照される号個体識別番号
    • device_id : FIDO認証器のデバイスID
    • user_id : 割り当てられたログインユーザID
    • created_at : FIDO認証器の登録日時
    • updated_at : 情報更新日時
    • device_name : FIDO認証器の名前
    • is_enabled : 有効かどうか
  • item_count: 検索結果の全件数

エラーレスポンス

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