YubiKeyの更新¶

ネームスペースにあるYubiKeyの情報を更新します。

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

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

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

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

注意

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

APIキーに必要な権限¶

YubiKey : UPDATE

メソッド¶

PUT

URL¶

/v1/yubikeys/:device_id

URLパラメータ¶

Content-Type: application/json

パラメータ名	必須	型	内容
:device_id	●	文字列	YubiKeyのデバイスID。OTPの先頭12桁。
is_enabled		真偽値	有効かどうか。デフォルトは有効。
aes		文字列	独自AESのYubiKeyで、AESを変更する場合に入力して下さい。
otp		文字列	YubiKeyのワンタイムパスワード。AESを変更する場合入力して下さい。

注意

登録後、オリジナルAESと独自AESを切り替えることはできません。
切り替える場合は、一度YubiKeyを削除してから、再度YubiKeyを登録して下さい。

パラメータ"otp"は、パラメータ"aes"と併せて使用します。

リクエスト例¶

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

<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キーのタイムゾーンが適用されます。

エラーレスポンス¶

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