ErrorResponse

Objet ErrorResponse pour toutes les méthodes. Il s'agit de la réponse qui s'affiche au lieu du type de réponse habituel en cas d'erreur. Cet objet ne doit pas être utilisé pour les refus fondés sur la logique métier.

Représentation 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.
}
Champs
responseMetadata

object (ResponseMetadata)

Métadonnées de la réponse, obligatoires pour toutes les réponses.

errorDescription

string

Fournit une description de cet état pour que les représentants de l'assistance puissent déboguer les erreurs. Sachez qu'elle n'est jamais montrée aux utilisateurs. Elle peut contenir du texte descriptif non sensible utilisé pour le débogage. Notez que certaines valeurs de errorResponseCode doivent être accompagnées d'informations supplémentaires dans ce champ.

Avertissement: N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce message.

issuerErrorIdentifier

string

Cet identifiant est spécifique à l'émetteur. Il est généré par l'émetteur. Il est utilisé à des fins de débogage uniquement afin d'identifier cette erreur. Il s'agit de l'identifiant par lequel l'émetteur connaît cette erreur.

Champ d'union result. OneOf qui capture le type d'erreur survenue. result ne peut être qu'un des éléments suivants :
invalidApiVersion

object (InvalidApiVersion)

Utilisé si la version d'API de la requête n'est pas acceptée. Code HTTP recommandé: 400

invalidPayloadSignature

object (InvalidPayloadSignature)

Utilisé si la signature de la charge utile est effectuée avec une clé inconnue ou inactive. Code HTTP recommandé: 401

invalidPayloadEncryption

object (InvalidPayloadEncryption)

Utilisé si le chiffrement de la charge utile est effectué avec une clé inconnue ou inactive. Code HTTP recommandé: 400

invalidIdentifier

object (InvalidIdentifier)

Utilisé si un identifiant envoyé dans la requête n'est pas valide ou est inconnu. Code HTTP recommandé: 404

invalidFieldValue

object (InvalidFieldValue)

Utilisé si la requête contient une valeur pour un champ qui ne fait pas partie de l'ensemble des valeurs acceptées. Code HTTP recommandé: 400

missingRequiredField

object (MissingRequiredField)

Utilisé si un champ obligatoire n'est pas défini dans la requête. Code HTTP recommandé: 400

invalidDecryptedRequest

object (InvalidDecryptedRequest)

Utilisé si la charge utile de la requête a pu être déchiffrée, mais que le message résultant n'a pas pu être analysé. Code HTTP recommandé: 400

permissionDenied

object (PermissionDenied)

Utilisé si la requête a été refusée en raison de problèmes liés aux identifiants d'autorisation envoyés par Google lors des appels d'API. Code HTTP recommandé: 403

forbidden

object (Forbidden)

L'accès à la ressource demandée est interdit. Code HTTP recommandé: 403

invalidState

object (InvalidState)

Utilisé si une requête a été effectuée, mais que le système n'est pas en état de l'exécuter. Par exemple, mdl.provisionCredential est appelé par une confirmation Rejected. Code HTTP recommandé: 400

InvalidApiVersion

Objet contenant des informations sur une erreur de version d'API non valide.

Représentation JSON
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
Champs
requestVersion

object (Version)

Version non valide qui était spécifiée dans la requête.

expectedVersion

object (Version)

Version attendue.

InvalidPayloadSignature

Ce message est volontairement vide pour l'instant. De nouveaux champs pourraient être ajoutés à l'avenir.

InvalidPayloadEncryption

Ce message est volontairement vide pour l'instant. De nouveaux champs pourraient être ajoutés à l'avenir.

InvalidIdentifier

Objet contenant des informations sur une erreur d'identifiant non valide.

Représentation JSON
{
  "invalidIdentifierType": string
}
Champs
invalidIdentifierType

string

Type d'identifiant qui n'était pas valide (ID de correction, ID du document, etc.).

InvalidFieldValue

Objet contenant des informations sur une erreur de valeur de champ non valide.

Représentation JSON
{
  "invalidFieldName": string
}
Champs
invalidFieldName

string

Nom du champ qui s'est avéré non valide.

MissingRequiredField

Objet contenant des informations sur une erreur de champ obligatoire manquant.

Représentation JSON
{
  "missingFieldNames": [
    string
  ]
}
Champs
missingFieldNames[]

string

Noms des champs manquants.

InvalidDecryptedRequest

Ce message est volontairement vide pour l'instant. De nouveaux champs pourraient être ajoutés à l'avenir.

PermissionDenied

Objet contenant des informations sur une erreur d'autorisation refusée.

Représentation JSON
{
  "reason": string
}
Champs
reason

string

Motif du refus de l'autorisation.

Interdit

Ce message est volontairement vide pour l'instant. De nouveaux champs pourraient être ajoutés à l'avenir.

InvalidState

Ce message est volontairement vide pour l'instant. De nouveaux champs pourraient être ajoutés à l'avenir.