ErrorResponse

Objeto ErrorResponse para todos os métodos. Se ocorrer um erro, ele será retornado em vez do tipo de resposta usual. Esse objeto não deve ser usado para rejeições baseadas em lógica de negócios.

Representação 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.
}
Campos
responseMetadata

object (ResponseMetadata)

Os metadados sobre a resposta, obrigatórios para todas elas.
errorDescription

string

Descreva esse status para que os representantes de suporte depurem os erros. Isso nunca é mostrado aos usuários. Pode conter texto descritivo e não confidencial usado para depuração. Alguns valores de errorResponseCode precisam ser acompanhados por detalhes adicionais neste campo.

Atenção: não inclua nenhuma PII nesta mensagem.
issuerErrorIdentifier

string

Esse identificador é especificamente gerado pelo emissor. Ele é usado para fins de depuração apenas para identificar esse erro. O emissor conhece esse erro pelo identificador.
Campo de união result. Um oneof que captura o tipo de erro ocorrido. result pode ser apenas de um dos tipos a seguir:
invalidApiVersion

object (InvalidApiVersion)

Usado se a versão da API da solicitação não for compatível. Código HTTP recomendado: 400
invalidPayloadSignature

object (InvalidPayloadSignature)

Usado se a assinatura do payload for para uma chave desconhecida ou inativa. Código HTTP recomendado: 401
invalidPayloadEncryption

object (InvalidPayloadEncryption)

Usado se a criptografia do payload for para uma chave desconhecida ou inativa. Código HTTP recomendado: 400
invalidIdentifier

object (InvalidIdentifier)

Usado se um identificador enviado na solicitação for inválido ou desconhecido. Código HTTP recomendado: 404
invalidFieldValue

object (InvalidFieldValue)

Usado se a solicitação contém um valor para um campo que não esteja no conjunto de valores compatíveis. Código HTTP recomendado: 400
missingRequiredField

object (MissingRequiredField)

Usado se um campo obrigatório não estiver definido na solicitação. Código HTTP recomendado: 400
invalidDecryptedRequest

object (InvalidDecryptedRequest)

Usado se o payload da solicitação puder ser descriptografado, mas a mensagem resultante não puder ser analisada. Código HTTP recomendado: 400
permissionDenied

object (PermissionDenied)

Usado se a solicitação foi recusada devido a problemas relacionados a qualquer credencial de permissão que o Google envia nas chamadas de API. Código HTTP recomendado: 403
forbidden

object (Forbidden)

O acesso ao recurso solicitado é proibido. Código HTTP recomendado: 403
invalidState

object (InvalidState)

Usado se uma solicitação for feita, mas o sistema não estiver em um estado válido para executar a solicitação. Por exemplo, mdl.provisionCredential é chamado com uma comprovação rejeitada. Código HTTP recomendado: 400

InvalidApiVersion

Objeto contendo informações sobre um erro de versão de API inválida.

Representação JSON 
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
Campos
requestVersion

object (Version)

A versão inválida especificada na solicitação.
expectedVersion

object (Version)

A versão esperada.

InvalidPayloadSignature

Esta mensagem está intencionalmente vazia no momento. Novos campos podem ser adicionados no futuro.

InvalidPayloadEncryption

Esta mensagem está intencionalmente vazia no momento. Novos campos podem ser adicionados no futuro.

InvalidIdentifier

Objeto contendo informações sobre um erro de identificador inválido.

Representação JSON 
{
  "invalidIdentifierType": string
}
Campos
invalidIdentifierType

string

O tipo de identificador inválido, por exemplo, documento de comprovação, documento de identidade etc.

InvalidFieldValue

Objeto contendo informações sobre um erro de valor de campo inválido.

Representação JSON 
{
  "invalidFieldName": string
}
Campos
invalidFieldName

string

O nome do campo que foi considerado inválido.

MissingRequiredField

Objeto contendo informações sobre um erro de campo obrigatório ausente.

Representação JSON 
{
  "missingFieldNames": [
    string
  ]
}
Campos
missingFieldNames[]

string

Os nomes dos campos ausentes.

InvalidDecryptedRequest

Esta mensagem está intencionalmente vazia no momento. Novos campos podem ser adicionados no futuro.

PermissionDenied

Objeto contendo informações sobre um erro de permissão negada.

Representação JSON 
{
  "reason": string
}
Campos
reason

string

O motivo de negar a permissão.

Proibido

Esta mensagem está intencionalmente vazia no momento. Novos campos podem ser adicionados no futuro.

InvalidState

Esta mensagem está intencionalmente vazia no momento. Novos campos podem ser adicionados no futuro.