OATH一覧の取得¶

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

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

APIキーに必要な権限¶

OATH : LIST

メソッド¶

GET

URL¶

/v1/oath

URLパラメータ¶

パラメータ名	型	内容
sort_field	文字列	ソートするフィールド名(device_id, name, is_enabled, created_at)。デフォルトはcreated_at。
sort_order	文字列	ソートの並び。desc(デフォルト) または asc。
page_index	数値	現在のページ。デフォルトは1。
page_size	数値	1ページあたりの件数。デフォルトは20。最大50。
device_id	文字列	検索条件。デバイスID。
name	文字列	検索条件。OATHの認証システムに表示される名前。
service	文字列	検索条件。このデバイスが紐付けられているサービス名。
is_enabled	真偽値	検索条件。有効かどうか。
created_at	文字列	検索条件。作成日付 ('YYYY-MM-DD')。タイムゾーンはUTC。
unused_days	数値	未使用期間。デフォルトは未指定（未使用期間の検索は行わない）。最大9999。OATHが使用されていない日数。 ※未使用期間の検索は、デバイス情報の編集や認証など、最終的に情報を更新した日時を元に検索します。

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

リクエスト例¶

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

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

APIマーケットプレイスモデルの場合

APIのエンドポイント(URL)は、APIマーケットプレイスを参照してください。

レスポンス例¶

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

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

レスポンスボディ¶

{
    items: [
        {
            "device_id": "xxxxxxxxxxxx",
            "name": "taro",
            "service": "example.com",
            "is_enabled": true,
            "created_at": "2020-10-30 10:10:00"
        },
        ...
    ],
    item_count: 20
}

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

注意

タイムゾーンはAPIキーのタイムゾーンが適用されます。

エラーレスポンス¶

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