YubicoのAPI Keyを取得する方法

概要

Yubico社のYubiKeyを独自のサービスで使うために必要な、API Keyを取得する方法をまとめました。

YubicoのAPI Key

先日、ハードウェアキーのYubiKeyを購入しました。せっかく購入したのであれば、YubiKeyを認証に設定できるサービスでは、そのYubiKeyを設定して利用したいものです。

私がサーバーを借りて利用しているものに、Vaultwardenがあります。これはBitwardenというパスワード管理サービスのクローンソフトウェアで、自前のサーバーにインストールして使うものです。実は、VaultwardenはYubiKeyをログイン認証に使うことができます。そこで、VaultwardenでYubiKeyを使うために設定をしてみました。

しかし、この設定時に外部のサービスとは異なり、Yubico社の発行するAPI Keyが必須でした。また、API Keyの発行について少し分かりにくいところがあり、手間取りました。

このような状況でYubicoのAPI Keyを発行する方法について紹介します。

API Keyの発行

API Keyの発行として、最終的にIDとKeyを発行します。

最初に、Yubicoの公式サイトにアクセスします。

Yubico API key signup

表示されたページについて、「Email address」のところに、適当なメールアドレスをします。さらに、「YubiKey OTP」のところに、YubiKeyをパソコンに接続してボタンをタッチして入力される文字列を入力します。

その後、利用規約などに同意するチェックを入れて、「Get API Key」をクリックします。

次に進むと、Client IDやSecret Keyが表示されます。

これらが、YubiKeyを使った認証に使うAPI Keyとなります。利用するサービスなどに適切に設定をしてください。

これで、API Keyの発行方法についての説明は終わりです。

さいごに

公式での説明が全て英語であったり、発行のためのWebページの説明がほとんどなかったりで、設定までに手間取りました。基本的に、Email addressには適当なメールアドレスを、YubiKey OTPには、所持しているYubiKeyを利用して生成した文字列を入力するようです。

YubiKeyの扱いに困っている方の参考になれば嬉しいです。