本文へ移動

デジタル認証アプリ

テストカード代替機能

公開日

更新日

テストカード代替機能

デジタル認証アプリおよびテスト用のマイナンバーカードを使用することなくサービスに組み込んだ認証および署名機能をテストすることができる機能です。

テスト用マイナンバーカードを持っていないサービス事業者もデジタル認証アプリの接続が簡単にできるようにする機能です。いくつかあるテストデータの中からデータを選択し、データに従ったAPIレスポンスを返却します。テストカード代替機能を使用する場合とテスト用デジタル認証アプリ(テスト用マイナンバーカード)を使ったテストとを両立することはできません。
認証APIをご利用のサービス事業者のみに提供します。

事前準備

以下の開発者サイトのドキュメントをご参照の上、RPとテスト環境への連携を行ってください。

https://developers.digital.go.jp/documents/auth-and-sign/implement-guideline/

RPからデジタル認証アプリサーバへ認可リクエストを実行してください。サービスのウェブページからリダイレクトされ、以下のデジタル認証アプリ 認証API/署名APIテストレスポンス設定画面が表示されます。

下記にデジタル認証アプリ 認証API/署名APIテストレスポンス設定画面の操作方法を示します。

認証APIテストレスポンス設定画面操作方法

画面項目

  1. 認証APIテストレスポンス設定画面には以下の項目が表示されます。

    認証APIテストレスポンス設定画面レイアウト01

    • 証明書タイプ
      テストカード情報一覧で選択する証明書のタイプを選択します。
    • レスポンス
      認可リクエストエンドポイントのレスポンスを選択します。
    • エラーパターン
      レスポンスで[異常]を選択した場合に、認可リクエストエンドポイントで返却するエラーの内容を選択します。
    • テストカード情報一覧
      認証APIのテストでテスト可能なマイナンバーカードおよびスマホ用電子証明書の一覧が表示されます。
      テストしたい内容に合わせたテストカード情報を選択します。
      証明書タイプを選択した場合は一致する証明書タイプのテストカード情報が表示されます。

正常レスポンスを返却する場合

  1. 証明書タイプから[マイナンバーカード]または[スマホ用電子証明書]ラジオボタンを選択します。

    認証スクリーンショット01

    証明書タイプを選択すると画面下部のテストカード情報一覧は選択した証明書タイプに応じたテストカードが表示されます。

  2. レスポンスから[正常]ラジオボタンを選択します。

    認証スクリーンショット02

  3. テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。

    認証スクリーンショット04

  4. RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト(認可コードフロー)などの後続処理を行うことができます。

異常レスポンスを返却する場合

  1. レスポンスから[異常]ラジオボタンを選択します。

    認証スクリーンショット05

  2. 「エラーパターン」の中からテストを実施したいエラーパターンを選択します。

    specified_certificate_type_not_mach エラーは一般利用を想定していないため、選択しないようお願いします。
    ※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
    認証スクリーンショット06

  3. テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。
    認証スクリーンショット07

  4. 選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。

    • RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。

    • レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。

    認証スクリーンショット08

    • 選択したエラーパターンがHTTP 503エラーを発生する合は、以下のエラーページが表示されます。

    認証スクリーンショット09

    • 選択したエラーパターンがHTTP 504エラーを発生する場合は、以下のエラーページが表示されます。

    認証スクリーンショット10

署名APIテストレスポンス設定画面操作方法

画面項目

  1. 署名APIテストレスポンス設定画面には以下の項目が表示されます。

    署名APIテストレスポンス設定画面レイアウト01

    • 証明書タイプ
      テストカード情報一覧で選択する証明書のタイプを選択します。
    • 署名トランザクションID
      署名トランザクション開始エンドポイントで発行した署名トランザクションIDを表示します。この値は編集できません。
    • レスポンス
      認可リクエストエンドポイントのレスポンスを選択します。
    • エラーパターン
      レスポンスで[異常]を選択した場合に、認可リクエストエンドポイントで返却するエラーの内容を選択します。
    • 署名トランザクション結果取得エラーパターン
      レスポンスで[異常]を選択した場合に、署名トランザクション結果取得エンドポイントで返却するエラーの内容を選択します。
    • テストカード情報一覧
      署名APIのテストでテスト可能なマイナンバーカードおよびスマホ用電子証明書の一覧が表示されます。
      テストしたい内容に合わせたテストカード情報を選択します。
      証明書タイプを選択した場合は一致する証明書タイプのテストカード情報が表示されます。

正常レスポンスを返却する場合

  1. 証明書タイプから[マイナンバーカード]または[スマホ用電子証明書]ラジオボタンを選択します。

    署名スクリーンショット01

    証明書タイプを選択すると画面下部のテストカード情報一覧は選択した証明書タイプに応じたテストカードが表示されます。

  2. レスポンスから[正常]ラジオボタンを選択します。

    署名スクリーンショット02

  3. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。

    署名スクリーンショット04

  4. RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト(認可コードフロー)などの後続処理を行うことができます。

異常レスポンスを返却する場合

エラーパターンのエラーをテストしたい場合

入力項目「エラーパターン」の中からテストを実施したいエラーパターンを選択します。
このエラーパターンは、一般的な異常状況をテストするために使用されます。

  1. レスポンスから[異常]ラジオボタンを選択します。

    署名スクリーンショット05

  2. エラーパターンの中からテストを実施したいエラーパターンを選択します。

    ※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。

    署名スクリーンショット06

  3. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。

    署名スクリーンショット07

  4. 選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。

    • RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。

    • レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。

    署名スクリーンショット08

  • エラーパターンを選択した結果HTTP 503エラーの場合は以下のエラー画面が表示されます。

    署名スクリーンショット09

  • エラーパターンを選択した結果HTTP 504エラーの場合は以下のエラー画面が表示されます。

    署名スクリーンショット10

署名トランザクション結果取得エラーパターンのエラーをテストしたい場合

入力項目「エラーパターン」は[-](未選択)を選択し、

入力項目「署名トランザクション結果取得エラーパターン」の中からエラーパターンを選択してください。
このエラーパターンは、特定の異常状況を検証するために使用されます。

  1. [異常]ラジオボタンを選択します。

    署名スクリーンショット11

  2. 署名トランザクション結果取得エラーパターンを選択します。

    specified_certificate_type_not_mach エラー、specified_certificate_type_unavailable エラーは一般利用を想定していないため、選択しないようお願いします。
    ※署名トランザクション結果取得エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。

    署名スクリーンショット12

  3. テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。

    署名スクリーンショット13

  4. RPへ署名トランザクション結果取得レスポンスが返却されますのでエラーの内容を確認してください。

バックチャネルログアウトを実行する場合

テストカード代替機能において、デジタル認証アプリサーバからRPのサーバへback-channel logoutリクエストを発生させるためには、以下の手順を行なってください。

  1. テストカード代替機能の"正常レスポンスを返却する場合”の操作を行い、サーバにおいてクライアントアサーションの取得とリフレッシュトークン、IDトークン、IDトークンに含まれるsub値のいずれかを取得してください

  2. 下記の通りHTTP POSTリクエストを送信します。

    • リフレッシュトークンを使用する場合
      URL:https://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout
      Content-Type:application/x-www-form-urlencoded
      リクエストボディ:
      • client_assertion_type:urn:ietf:params:oauth:client-assertion-type:jwt-bearer
      • client_assertion:クライアントアサーション(クライアント認証のための情報を含むJWT)
      • refresh_token:アクセストークン発行レスポンスに含まれるリフレッシュトークン
    • IDトークンを使用する場合
      URL:https://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout
      Content-Type:application/x-www-form-urlencoded
      リクエストボディ:
      • client_assertion_type:urn:ietf:params:oauth:client-assertion-type:jwt-bearer
      • client_assertion:クライアントアサーション(クライアント認証のための情報を含むJWT)
      • id_token:アクセストークン発行レスポンスに含まれるIDトークン
    • Sub値を使用する場合
      URL:https://sb-auth-and-sign.go.jp/api/realms/main/sandbox/logout
      Content-Type:application/x-www-form-urlencoded
      リクエストボディ:
      • client_assertion_type:urn:ietf:params:oauth:client-assertion-type:jwt-bearer
      • client_assertion:クライアントアサーション(クライアント認証のための情報を含むJWT)
      • subject_id:アクセストークン発行レスポンスのIDトークンに含まれるsub値
  3. バックチャネルログアウトが成功した場合、下記の通りレスポンスが返却されます。
    HTTPステータス:200
    Content-Type: application/json
    レスポンスボディ:

    • executed_backchannel_logout:true

エラーパターンの詳細

エラーパターンに関しては以下をご参照ください。

入力項目選択値概要認証/署名ボタン押下後動作
エラーパターンinvalid_request・Missing parameter: ○○○○
リクエストに必須パラメータのキーが存在しない。
※「○○○○」には必須パラメータ名が設定される。
・Invalid parameter: ○○○○
リクエストの必須パラメータに値が設定されていない。
リクエストのパラメータに未知の値が設定されている。
※「○○○○」には必須パラメータ名が設定される。
・Invalid initialRegistrationSessionId for authentication
初期登録セッションIDが設定されてない。
・Check initialRegistrationSessionId by backend failed
初期登録セッションIDが不正。
・Invalid initialRegistrationSessionId for authentication
初期登録セッションIDが不正。
・No refresh token
リクエストに必須パラメータ(refresh_token)が存在しない。
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンunsupported_response_typeデジタル認証アプリサーバは設定された方法による認可コード取得をサポートしていない。
・リクエストの必須パラメータ(response_type)に値が設定されていない。
・リクエストのパラメータ(response_type)に未知の値が設定されている
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンunauthorized_client・Client is not allowed to initiate browser login with given response_type. Implicit flow is disabled for the client.
リクエストパラメータの指定誤り。(response_typeに"token"が設定されている)
・Client not allowed for direct access grants
リクエストパラメータの指定誤り。(grant_typeに"password"が設定されている)
・Invalid client credentials
該当クライアントがシステム側で停止されている。
・Invalid client secret
リクエストの必須パラメータ(client_secret)に値が設定されていない。
リクエストの必須パラメータ(client_secret)に未知の値が設定されている。
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンinvalid_scope・Invalid scopes: ○○○○
リクエストの scope に値が設定されていない。
リクエストの scopeに未知の値が設定されている。
※「○○○○」にはscopeの値が設定される。
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンaccess_denied・Internal error happened
その他の例外エラーが発生した場合。
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンaccess_denied(Authentication failed)・Authentication failed
マイナンバーカード読み取りエラーが発生した場合。
HTTP 302によってエラーレスポンスをRPへ返却
エラーパターンserver_error・Invalid admin consol parameter
デジタル認証アプリサーバ管理コンソール設定のバックエンドサーバURL設定がされていない。
デジタル認証アプリサーバ管理コンソール設定のキャッシュ時間が設定されていない。
デジタル認証アプリサーバ管理コンソール設定のキャッシュ時間が数値でない。
・Internal server error
通信エラー。
HTTP500でエラーレスポンスを返却
エラーパターンservice_temporarily_unavailableデジタル認証サービスシステムメンテナンス中の場合。HTTP 503 エラー画面を表示
エラーパターンjpki_temporarily_unavailable公的個人認証サービスメンテナンス中の場合。HTTP 503 エラー画面を表示
エラーパターンforbiddenアクセス拒否・アクセス権限がない場合HTTP 504 エラー画面を表示
エラーパターンpayload_too_largeリクエストの本文が長すぎてサーバが処理できない場合HTTP 504 エラー画面を表示
エラーパターンtoo_many_requestsクライアントが短期間に過剰なリクエストを送信したため、サーバがそれ以上のリクエストを処理できない場合HTTP 504 エラー画面を表示
エラーパターンbad_gatewayRPのサーバ側で起きた問題によって、一時的に正しくデータの送受信ができない場合HTTP 504 エラーページを表示
エラーパターンgateway_timeoutRPのサーバがリクエストを処理中にタイムアウトが発生した場合HTTP 504 エラー画面を表示
エラーパターンrequest_blockedWAF(Web Application Firewall)が攻撃検知した場合HTTP 504 エラー画面を表示
エラーパターンspecified_certificate_type_not_match特定ユースケース・特定RPのみで利用されるエラーHTTP 400でエラーレスポンスを返却
署名トランザクション結果取得エラーパターンinvalid_request-status署名トランザクションIDの状態が不正な状態の場合署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターンexpired_sign_transaction署名トランザクションが有効期限切れの場合署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターンinvalid_request-no_data署名トランザクションIDと一致するデータが存在しない場合署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターンlocked_certificate署名用電子証明書がロックされている場合署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターンnot_installed_certificate署名用電子証明書が搭載されていない場合署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターンspecified_certificate_type_not_match特定ユースケース・特定RPのみで利用されるエラーHTTP 400でエラーレスポンスを返却
署名トランザクション結果取得エラーパターンspecified_certificate_type_unavailable特定ユースケース・特定RPのみで利用されるエラーHTTP 302によってエラーレスポンスをRPへ返却

変更履歴

  • 2025-03-27
    • 初版公開
  • 2026-04-24
    • スマホ用電子証明書の証明書タイプとエラー種別を追加