YubiKeyの追加¶

ネームスペースにYubiKeyを追加します。

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

YubiKeyは、ネームスペース内で一意になります。

YubiKeyは大きく分けると二つに分類されます。

オリジナルAES : YubicoAPIに登録されているAESを使用しているYubiKey。
独自AES : ユーザがAESを変更し、YubicoAPIにAESを登録していないYubiKey。

当サービスでは、どちらのYubiKeyでもご利用できます。
ただし、独自AESのYubiKeyをサービスで利用するには、YubiKeyに設定したAESをサービスに登録する必要があります。

注意

AESは暗号化された状態で保存します。

登録後にAESの値を閲覧(確認)することはできませんので、AESの値は別途管理してください。

APIキーに必要な権限¶

YubiKey : CREATE

メソッド¶

POST

URL¶

/v1/yubikeys

URLパラメータ¶

Content-Type: application/json

パラメータ名	必須	型	内容
otp	●	文字列	YubiKeyのワンタイムパスワード。
is_enabled		真偽値	有効かどうか。デフォルトは有効。
is_customized		真偽値	独自AESかどうか。デフォルトは無効(オリジナルAES)。
aes		文字列	独自AES。is_customizedがtrueの場合、指定は必須。

リクエスト例¶

curl \
  -X POST \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"otp":"xxxxxx"}' \
  "https://api.d-auth.com/v1/yubikeys"

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

レスポンス例¶

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

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

レスポンスボディ¶

{
    "device_id": "xxxxxxxxxxxx"
    "is_customized": false,
    "is_enabled": true,
    "created_at": "2020-10-30 10:10:00"
}

device_id : YubiKeyのデバイスID(OTPの先頭12桁)

注意

AESとOTPカウンタ値は、取得できません。
タイムゾーンはAPIキーのタイムゾーンが適用されます。

エラーレスポンス¶

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