コンテンツにスキップ

セキュリティキー設定

コンソールパス

➡️ コンソールパス:App Center > セキュリティキー設定

概要

セキュリティキー設定では、OAuth 2.0認証プロセスでクライアントアプリケーションを識別し、サーバーとクライアント間のリクエストを検証するためのセキュリティキーをプロジェクトごとに設定します。

注意事項

  • 認証セキュリティプロトコルの変更により、SDK v4.25.0.0以降ではセキュリティキーの設定が必須です。
  • セキュリティキーが設定されていない場合、ユーザーはアプリにログインできません。アプリでSDK v4.25.0.0以降を使用している場合は、必ずセキュリティキーを設定してください。
  • セキュリティキーは、本番環境とサンドボックス環境でそれぞれ設定する必要があります。

セキュリティキーの確認

セキュリティキー設定画面でプロジェクトを検索すると、発行済みのセキュリティキーを確認できます。

セキュリティ上の理由により、Client Secretは初回生成時に一度だけ表示されます。生成後にページを再度開くと値はマスクされ、APIを呼び出してもClient Secretの値は返されません。

Warning
  • 生成後にClient Secretを再度確認したりコピーしたりすることはできません。
  • 生成直後に表示されるClient Secretを安全な場所に別途保管してください。

セキュリティキーの作成と削除

セキュリティキーの作成

  1. セキュリティキーが設定されていない場合は、生成を選択します。
  2. 生成されたセキュリティキーを確認します。
  3. 初回生成時に表示されるClient Secretを安全な場所に別途保管します。
  4. 保存を選択してセキュリティキーを保存します。

生成されたセキュリティキーのうち、Client IDは利便性のためSDKの初期化時にSDKへ保存されます。

Public KeyとClient IDはそれぞれ1つだけ生成でき、生成後は変更できません。Client Secretは同時に最大2つまで発行して使用できます。

Client Secretの切り替え

既存のClient Secretを確認できない場合や、Client Secretを切り替える必要がある場合は、次の手順に従ってください。

  1. 新しいClient Secretを追加で発行します。
  2. サービスで新しいClient Secretを使用するように変更します。
  3. 新しいClient Secretへの切り替えが正常に完了したことを確認します。
  4. 使用しなくなった既存のClient Secretを削除します。

新旧のClient Secretを同時に使用できるため、サービスを停止せずにClient Secretを切り替えられます。新しいClient Secretへ切り替える前に、既存のClient Secretを削除しないよう注意してください。

変更履歴

セキュリティキーの生成および削除履歴は、変更履歴で確認できます。

セキュリティキーのテスト

生成したセキュリティキーは、使用前にテストできます。App Center > セキュリティキーテストIP設定でIPアドレスを登録すると、セキュリティキーが無効な状態でも、そのIPアドレスからセキュリティキーを使用して通信できます。登録したIPアドレスはプロジェクト単位で管理されます。

IPアドレスの登録

  • IPアドレスは、数字とピリオド(.)のみで構成されたIPv4形式で入力してください。有効な範囲は0.0.0.0~255.255.255.255です。
  • 改行を使用して、複数のIPアドレスを一度に登録できます。
  • 同じIPアドレスを重複して入力した場合は、1件のみ登録されます。すでに登録されているIPアドレスは追加されません。

IPアドレスの確認と削除

  • 登録済みのIPアドレスは、IPリストで確認できます。
  • 各IPアドレスの右側にある削除を選択すると、個別に削除できます。