APIキーを登録する

APIにアクセスする際に使用するAPIキーを登録する操作について記載します。

情報

本手順を行うためには、対象のRPの検証が完了している必要があります。
RPの検証状態が「検証済み」になっていることを確認してください。

操作手順

メニューから「RP」を選択します。

  1. RP一覧テーブルから、使用したいRPの行をクリックしてRP詳細を表示します。 RP詳細 RP詳細

  2. APIキータブをクリックします。 APIキータブ APIキータブ

  3. 「APIキー登録」ボタンをクリックします。 APIキー登録ボタン APIキー登録ボタン

  4. APIキー登録モーダルで、各項目を入力します。 APIキー登録モーダル APIキー登録モーダル

    • API認証名称
      APIキーを識別するための名称です。
    • API認証種別
      APIキーを使用する際の認証方式を指定します。
      種別 説明
      Nonce署名認証 FIDO2ServerServiceが提供するNonce(ランダム値)を使用して署名を作成し、検証を行います。セキュリティレベルが一番高い方式です。APIリクエストごとに、Nonce値取得の通信が別途行われます。
      日付署名認証 日時を使用して署名を作成し、検証を行います。Nonce署名認証と比較すると、理論上では通信盗聴による短時間内でのリプレイ攻撃の可能性が発生しますが、十分にセキュリティレベルが高い方式です。利用者が非常に多いサービスなどでFIDO2ServerServiceへの通信による各種オーバーヘッドを抑えたい場合に利用をお勧めします。
      アクセスキー認証 固定のキーを使用し、キーが一致するかどうかの検証を行います。シンプルな方式です。
  5. 「登録」ボタンをクリックします。 登録ボタン 登録ボタン

  6. 確認メッセージでOKをクリックします。

  7. 登録に成功するとAPIキーの情報が表示されます。表示された各項目をコピーし、保存しておきます。 登録成功 登録成功

    • API認証ID
      APIアクセス時に使用するIDです。
    • API認証種別
      認証方法の種別です。
    • シークレットキー
      APIアクセス時に使用するシークレットキーです。
    警告

    シークレットキーはこのタイミングでしか表示されず、後から確認することはできません。
    テキストをコピーするなどして必ず保存しておいてください。

  8. 閉じるボタンをクリックしてモーダルを閉じます。