ErrorResponse

すべてのメソッドに対応する ErrorResponse オブジェクト。エラーが発生した場合、通常のレスポンス タイプの代わりに返されます。このオブジェクトは、ビジネス ロジックに基づく拒否には使用しないでください。

JSON 表現 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "errorDescription": string,
  "issuerErrorIdentifier": string,

  // Union field result can be only one of the following:
  "invalidApiVersion": {
    object (InvalidApiVersion)
  },
  "invalidPayloadSignature": {
    object (InvalidPayloadSignature)
  },
  "invalidPayloadEncryption": {
    object (InvalidPayloadEncryption)
  },
  "invalidIdentifier": {
    object (InvalidIdentifier)
  },
  "invalidFieldValue": {
    object (InvalidFieldValue)
  },
  "missingRequiredField": {
    object (MissingRequiredField)
  },
  "invalidDecryptedRequest": {
    object (InvalidDecryptedRequest)
  },
  "permissionDenied": {
    object (PermissionDenied)
  },
  "forbidden": {
    object (Forbidden)
  },
  "invalidState": {
    object (InvalidState)
  }
  // End of list of possible types for union field result.
}
フィールド
responseMetadata

object (ResponseMetadata)

レスポンスに関するメタデータ。すべてのレスポンスで必須。
errorDescription

string

サポート担当者がエラーをデバッグするために、このステータスの説明を提供します。ユーザーに対しては表示されません。デバッグに役立ち、機密情報を含まないテキストを含めることができます。errorResponseCode の一部の値は、このフィールドに追加の詳細を記述する必要があることに注意してください。

警告: このメッセージに個人を特定できる情報（PII）を含めないでください。
issuerErrorIdentifier

string

この識別子は発行者に固有で、発行者によって生成されます。このエラーを特定するためだけに、デバッグ目的で使用されます。これは、発行者がこのエラーを認識するための識別子です。
共用体フィールド result。発生したエラーの種類をキャプチャする oneof。result は次のいずれかになります。
invalidApiVersion

object (InvalidApiVersion)

リクエストの API バージョンが未対応の場合に使用します。通知される HTTP コード: 400
invalidPayloadSignature

object (InvalidPayloadSignature)

不明なキーまたは無効なキーでペイロードが署名された場合に使用されます。通知される HTTP コード: 401
invalidPayloadEncryption

object (InvalidPayloadEncryption)

不明なキーまたは無効なキーでペイロードが暗号化された場合に使用されます。通知される HTTP コード: 400
invalidIdentifier

object (InvalidIdentifier)

リクエストで送信された ID が無効か、不明な場合に使用されます。通知される HTTP コード: 404
invalidFieldValue

object (InvalidFieldValue)

サポートされている値のセットにない値がリクエストのフィールドに含まれている場合に使用されます。通知される HTTP コード: 400
missingRequiredField

object (MissingRequiredField)

リクエストで必須フィールドが未設定の場合に使用されます。通知される HTTP コード: 400
invalidDecryptedRequest

object (InvalidDecryptedRequest)

リクエスト ペイロードは復号できたが、メッセージを解析できない場合に使用されます。通知される HTTP コード: 400
permissionDenied

object (PermissionDenied)

Google が API 呼び出しで送信する権限証明書に関連する問題により、リクエストが拒否された場合に使用されます。通知される HTTP コード: 403
forbidden

object (Forbidden)

要求されたリソースへのアクセスは禁止されています。通知される HTTP コード: 403
invalidState

object (InvalidState)

要求が行われたが、システムが要求を実行するための有効な状態ではない場合に使用されます。例: mdl.provisionCredential は拒否された検証で呼び出されます。通知される HTTP コード: 400

InvalidApiVersion

無効な API バージョン エラーに関する情報を含むオブジェクト。

JSON 表現 
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
フィールド
requestVersion

object (Version)

リクエスト時に指定された無効なバージョンです。
expectedVersion

object (Version)

予想されるバージョン。

InvalidPayloadSignature

このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

InvalidPayloadEncryption

このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

InvalidIdentifier

無効な識別子のエラーに関する情報を含むオブジェクト。

JSON 表現 
{
  "invalidIdentifierType": string
}
フィールド
invalidIdentifierType

string

検証 ID やドキュメント ID など、無効な識別子のタイプ。

InvalidFieldValue

無効なフィールド値エラーに関する情報を含むオブジェクト。

JSON 表現 
{
  "invalidFieldName": string
}
フィールド
invalidFieldName

string

無効であることが判明したフィールドの名称。

MissingRequiredField

必須フィールドの欠落エラーに関する情報を含むオブジェクト。

JSON 表現 
{
  "missingFieldNames": [
    string
  ]
}
フィールド
missingFieldNames[]

string

欠落しているフィールドの名前。

InvalidDecryptedRequest

このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

PermissionDenied

権限拒否エラーに関する情報を含むオブジェクト。

JSON 表現 
{
  "reason": string
}
フィールド
reason

string

権限を拒否する理由。

禁止

このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

InvalidState

このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。