API Docs
v6.1.0
  • v5.9.0
  • v6.1.0
ガードAPI仕様
よくある質問
ガードAPI仕様
よくある質問
v6.1.0
  • v5.9.0
  • v6.1.0
v6.1.0
  • v5.9.0
  • v6.1.0
  1. 認証&認可API
  • APIの概要
  • システム構成
  • 認証&認可API
    • 概要
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • 本人確認API
    • 概要
    • Userdata
      GET
  • 電子署名API
    • 概要
    • Signing
      POST
    • SigningStatus
      GET
    • Certificate
      GET
    • SigningRedirect
      POST
  • 本人確認情報更新API
    • 概要
    • Re:Verification
      POST
    • Re:VerificationStatus
      GET
    • Re:VerificationRedirect
      POST
  • 公的個人認証API
    • 概要
    • JPKI
      POST
    • JPKIStatus
      GET
    • JPKIRedirect
      POST
  • マイナポータル向け公的個人認証API
    • 概要
    • JPKIPittari
      POST
    • JPKIPittariRedirect
      POST
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助API
    • 概要
    • CardInput
    • CardInputStatus
    • CardInputRedirect
  1. 認証&認可API

概要

認証&認可フローを実施し、利用者のアクセストークン、識別情報を取得するためのAPIです。
認証&認可APIは、以下の3つのエンドポイントで構成されています。
Authorization(利用者への認可リクエストを発行する)
Token(利用者のアクセストークンを取得する)
UserInfo(利用者情報を取得する)
AuthorizationおよびTokenリクエストを経て取得されたアクセストークンをリクエストヘッダーに含めることで、xID APIのその他のエンドポイントの呼び出しが可能になります。
UserInfoで取得される利用者の情報のうち、 sub は特定の認可クライアントに対して認証&認可プロセスを実施した利用者に割り当てられるユニークな識別子です。

OIDC認可フローについて#

OpenID Connect(OIDC)の詳細については本ドキュメントでは詳細な説明は割愛します。
OIDCはOAuth2.0の拡張プロトコルとして作成されており、多くのライブラリやパッケージが公開されています。

参考ガイド#

OpenID Connect ファウンデーション 公開資料
解説動画 from Okta
ライブラリ等
OIDC Debugger
JWT.IO
情報
独自のOIDCフローの実装はセキュリティに脆弱性を生む可能性があり、非推奨です。

PCでの認証&認可フロー#

利用者がPCを利用して認証&認可プロセスを実施する場合、利用者がサービス画面とxIDアプリ画面に表示される確認コードを照合するプロセスが生じます。

シーケンス#

利用者フロー#

authorization-flow.png

モバイル端末での認証&認可フロー#

モバイル端末で認証&認可フローを実施する場合は、確認コードの照合手順は省略されます。

シーケンス#

利用者フロー#

PIN1の入力は生体認証(指紋認証・顔認証)で省略可能です。
authorization-mobile-flow.png
更新日時 2026-06-05 08:43:06
前へ
認証&認可API
次へ
Authorization
Built with