デジタル認証アプリ

テストカード代替機能

公開日2025年03月27日

テストカード代替機能

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

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

事前準備

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

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

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

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

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

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

レスポンスから[正常]ラジオボタンを選択します。
テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。
RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト（認可コードフロー）などの後続処理を行うことができます。

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

レスポンスから[異常]ラジオボタンを選択します。
「エラーパターン」の中からテストを実施したいエラーパターンを選択します。

※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
テストカード情報一覧から認証を行うテストカード情報を選択し、[認証]ボタンを押下します。
選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。
- RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。
- レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。
- 選択したエラーパターンがHTTP 503エラーを発生する合は、以下のエラーページが表示されます。

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

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

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

レスポンスから[正常]ラジオボタンを選択します。
テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
RPへ認可レスポンスが返却されますので内容を確認してください。トークンリクエスト（認可コードフロー）などの後続処理を行うことができます。

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

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

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

レスポンスから[異常]ラジオボタンを選択します。
エラーパターンの中からテストを実施したいエラーパターンを選択します。

※エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
選択したエラーパターンに応じてエラーレスポンスを返却、またはエラー画⾯を表⽰します。
- RPへ認可レスポンスが返却されますのでエラーの内容を確認してください。
- レスポンスで異常を選択してエラーパターンを選択しない場合は以下のエラーメッセージが表示されます。

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

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

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

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

[異常]ラジオボタンを選択します。
署名トランザクション結果取得エラーパターンを選択します。

※署名トランザクション結果取得エラーパターンの意味は「エラーパターンの詳細」項目を参照してください。
テストカード情報一覧から署名を行うテストカード情報を選択し、[署名]ボタンを押下します。
RPへ署名トランザクション結果取得レスポンスが返却されますのでエラーの内容を確認してください。

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

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

テストカード代替機能の"正常レスポンスを返却する場合”の操作を行い、サーバにおいてクライアントアサーションの取得とリフレッシュトークン、IDトークン、IDトークンに含まれsub値のいずれかを取得してください
下記の通り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値
バックチャネルログアウトが成功した場合、下記の通りレスポンスが返却されます。
HTTPステータス：200
Content-Type: application/json
レスポンスボディ：
- executed_backchannel_logout：true

エラーパターンの詳細

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

入力項目	選択値	概要	認証/署名ボタン押下後動作
エラーパターン	invalid_request	・Missing parameter: ○○○○ リクエストに必須パラメータのキーが存在しない。 ※「○○○○」には必須パラメータ名が設定される。・Invalid parameter: ○○○○ リクエストの必須パラメータに値が設定されていない。リクエストのパラメータに未知の値が設定されている。 ※「○○○○」には必須パラメータ名が設定される。・Invalid initialRegistSessionId for authentication 初期登録セッションIDが設定されてない。・Check initialRegistSessionId by backend failed 初期登録セッションIDが不正。・Invalid initialRegistSessionId 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_gateway	RPのサーバー側で起きた問題によって、一時的に正しくデータの送受信ができない場合	HTTP 504 エラーページを表示
エラーパターン	gateway_timeout	RPのサーバーがリクエストを処理中にタイムアウトが発生した場合	HTTP 504 エラーページを表示
エラーパターン	request_blocked	WAF(Web Application Firewall)が攻撃検知した場合	HTTP 504 エラーページを表示
署名トランザクション結果取得エラーパターン	invalid_request-status	署名トランザクションIDの状態が不正な状態の場合	署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターン	expired_sign_transaction	署名トランザクションが有効期限切れの場合	署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターン	invalid_request-no_data	署名トランザクションIDと一致するデータが存在しない場合	署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターン	locked_certificate	署名用電子証明書がロックされている場合	署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却
署名トランザクション結果取得エラーパターン	not_installed_certificate	署名用電子証明書が搭載されていない場合	署名フローを完了させた後、署名トランザクション結果取得時にエラーレスポンスを返却

変更履歴

2025-03-27
- 初版公開