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의 일부 값에는 이 필드에 추가 세부정보가 있어야 합니다.

경고: 이 메시지에 개인 식별 정보를 포함하지 마세요.

issuerErrorIdentifier

string

이 식별자는 발급기관에 따라 다르며 발급기관에서 생성합니다. 이 오류를 식별하기 위한 디버깅 목적으로만 사용됩니다. 발급자가 이 오류를 식별하는 식별자입니다.

통합 필드 result. 발생한 오류 유형을 캡처하는 oneof입니다. result은 다음 중 하나여야 합니다.
invalidApiVersion

object (InvalidApiVersion)

요청의 API 버전이 지원되지 않는 경우에 사용됩니다. 권장 HTTP 코드: 400

invalidPayloadSignature

object (InvalidPayloadSignature)

페이로드의 서명이 알 수 없거나 비활성 키인 경우에 사용됩니다. 권장 HTTP 코드: 401

invalidPayloadEncryption

object (InvalidPayloadEncryption)

페이로드 암호화가 알 수 없거나 비활성 키인 경우에 사용됩니다. 권장 HTTP 코드: 400

invalidIdentifier

object (InvalidIdentifier)

요청에 전송된 식별자가 잘못되었거나 알 수 없는 경우에 사용됩니다. 권장 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

이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.