ErrorResponse

ErrorResponse-Objekt für alle Methoden. Dieses Objekt wird statt des üblichen Antworttyps zurückgegeben, wenn ein Fehler vorliegt. Das Objekt darf nicht für Ablehnungen aufgrund der Geschäftslogik verwendet werden.

JSON-Darstellung 
{
  "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.
}
Felder
responseMetadata

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.
errorDescription

string

Geben Sie eine Beschreibung dieses Status an, damit Supportmitarbeiter Fehler beheben können. Dieser Text wird Nutzern nicht angezeigt. Er kann beschreibenden nicht sensiblen Text für die Fehlerbehebung enthalten. Beachte, dass bei einigen Werten für „errorResponseCode“ zusätzliche Informationen in diesem Feld angegeben werden sollten.

Warnung: Diese Nachricht darf keine personenidentifizierbaren Informationen enthalten.
issuerErrorIdentifier

string

Diese Kennung ist ausstellerspezifisch und wird vom Aussteller generiert. Sie wird nur zum Zweck der Fehlerbehebung verwendet, um diesen Fehler zu identifizieren. Dies ist die Kennung, anhand derer der Aussteller diesen Fehler erkennt.
Union-Feld result. Ein Oneof, das die Art des Fehlers erfasst. Für result ist nur einer der folgenden Werte zulässig:
invalidApiVersion

object (InvalidApiVersion)

Wird verwendet, wenn die API-Version der Anfrage nicht unterstützt wird. Empfohlener HTTP-Code: 400
invalidPayloadSignature

object (InvalidPayloadSignature)

Wird verwendet, wenn die Signatur der Nutzlast für einen unbekannten oder inaktiven Schlüssel ist. Empfohlener HTTP-Code: 401
invalidPayloadEncryption

object (InvalidPayloadEncryption)

Wird verwendet, wenn die Verschlüsselung der Nutzlast für einen unbekannten oder inaktiven Schlüssel ist. Empfohlener HTTP-Code: 400
invalidIdentifier

object (InvalidIdentifier)

Wird verwendet, wenn eine in der Anfrage gesendete Kennung ungültig oder unbekannt war. Empfohlener HTTP-Code: 404
invalidFieldValue

object (InvalidFieldValue)

Wird verwendet, wenn die Anfrage einen Wert für ein Feld enthält, das sich nicht im Satz unterstützter Werte befindet. Empfohlener HTTP-Code: 400
missingRequiredField

object (MissingRequiredField)

Wird verwendet, wenn ein erforderliches Feld in der Anfrage nicht festgelegt ist. Empfohlener HTTP-Code: 400
invalidDecryptedRequest

object (InvalidDecryptedRequest)

Wird verwendet, wenn die Anfragenutzlast zwar entschlüsselt, aber die Nachricht nicht geparst werden konnte. Empfohlener HTTP-Code: 400
permissionDenied

object (PermissionDenied)

Wird verwendet, wenn die Anfrage aufgrund von Problemen in Verbindung mit Berechtigungsnachweisen abgelehnt wurde, die Google in den API-Aufrufen sendet. Empfohlener HTTP-Code: 403
forbidden

object (Forbidden)

Der Zugriff auf die angeforderte Ressource ist verboten. Empfohlener HTTP-Code: 403
invalidState

object (InvalidState)

Wird verwendet, wenn eine Anfrage gesendet wurde, aber das System keinen gültigen Status hat, um die Anfrage auszuführen. Beispiel: mdl.provisionCredential wird mit dem Proofing „Abgelehnt“ aufgerufen. Empfohlener HTTP-Code: 400

InvalidApiVersion

Objekt mit Informationen zu einem Fehler aufgrund einer ungültigen API-Version.

JSON-Darstellung 
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
Felder
requestVersion

object (Version)

Die in der Anfrage angegebene ungültige Version.
expectedVersion

object (Version)

Die erwartete Version.

InvalidPayloadSignature

Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

InvalidPayloadEncryption

Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

InvalidIdentifier

Objekt mit Informationen zu einem Fehler aufgrund einer ungültigen Kennung.

JSON-Darstellung 
{
  "invalidIdentifierType": string
}
Felder
invalidIdentifierType

string

Die Art der Kennung, die ungültig war, z.B. Proofing-ID, Dokument-ID usw.

InvalidFieldValue

Objekt mit Informationen zu einem Fehler aufgrund eines ungültigen Feldwerts.

JSON-Darstellung 
{
  "invalidFieldName": string
}
Felder
invalidFieldName

string

Der Name des Felds, das als ungültig erachtet wurde.

MissingRequiredField

Objekt mit Informationen zu einem Fehler aufgrund eines fehlenden Pflichtfelds.

JSON-Darstellung 
{
  "missingFieldNames": [
    string
  ]
}
Felder
missingFieldNames[]

string

Die Namen der fehlenden Felder.

InvalidDecryptedRequest

Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

PermissionDenied

Objekt mit Informationen zu einem Fehler aufgrund einer abgelehnten Berechtigung.

JSON-Darstellung 
{
  "reason": string
}
Felder
reason

string

Der Grund, aus dem die Berechtigung abgelehnt wird.

Verboten

Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

InvalidState

Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.