Freigeben über

Fehlercodes der Anforderungsdienst-API

  • Artikel

Hinweis

Microsoft Entra Verified ID ist jetzt Teil der Microsoft Entra-Produktfamilie. Erfahren Sie mehr über die Microsoft Entra-Familie mit Lösungen für die Identitätsverwaltung, und beginnen Sie im einheitlichen Microsoft Entra Admin Center.

Microsoft Entra Verified ID bietet die REST-API für den Anforderungsdienst, mit der Sie einen Nachweis ausstellen und überprüfen können. In diesem Artikel finden Sie die Fehlercodes für die Anforderungsdienst-API.

Error-Objekt

Während der öffentlichen Vorschau gab die Anforderungsdienst-API Fehler im folgenden Format zurück.

{
  "requestId": "4bb6726f77af7623ab52962323016442",
  "date": "Thu, 28 Apr 2022 14:30:54 GMT",
  "mscv": "17ppwf3uxR10MfRR.1",
  "error": {
    "code": "client_request.invalid_include_qr_code",
    "message": "The request contains `includeQRCode`, but it is not boolean."
  }
}

Dieses Format wurde nun in das folgende geändert, um sowohl eine einfachere Fehlerbehandlung als auch eine bessere Unterstützung der Problembehandlung zu ermöglichen. Im neuen Format enthalten der äußere Fehlercode und die Meldungsfelder standardisierte Werte, während das Objekt innererror Details zur Fehlerursache liefert.

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
Eigenschaft Type Beschreibung
requestId string Automatisch generierte Anforderungs-ID.
date date Der Zeitpunkt des Fehlers.
mscv Zeichenfolge Interner Microsoft-Code.
error Fehler Das äußere Fehlerobjekt

Fehlertyp

Das Objekt error entspricht jetzt dem vom API-Aufruf zurückgegebenen HTTP-Statuscode, um Entwicklern eine einfachere Fehlerbehandlung zu ermöglichen.

Eigenschaft Type Beschreibung
code Zeichenfolge Der zurückgegebene Fehlercode, der dem HTTP-Statuscode entspricht.
message Zeichenfolge Eine standardisierte Fehlermeldung, die auch vom zurückgegebenen HTTP-Statuscode abhängig ist.
innererror Innererror Liefert Details zur Fehlerursache.

Fehlercodes und -meldungen

Nachfolgend finden Sie die möglichen code-Werte der obersten Ebene, die den zurückgegebenen HTTP-Statuscodes zugeordnet sind.

HTTP-Statuscode code message
400 badRequest Die Anforderung ist ungültig.
401 Unbefugte Die angeforderte Ressource erfordert eine Authentifizierung.
403 forbidden Fehlende Berechtigungen zum Erfüllen dieser Anforderung.
404 NotFound Die angeforderte Ressource ist nicht vorhanden.
405 methodNotAllowed Die angeforderte Methode ist für die angeforderte Ressource nicht zulässig.
406 notAcceptable Das angeforderte Antwortformat wird nicht unterstützt.
408 requestTimeout Das Zeitlimit der Anforderung wurde überschritten.
409 Konflikt Der Server kann die Anforderung aufgrund eines Serverkonflikts nicht erfüllen.
410 gone Die angeforderte Ressource ist nicht mehr verfügbar.
411 contentLengthRequired Der Header Content-Length fehlt.
412 preconditionFailed Eine Voraussetzung für diese Anforderung ist nicht erfüllt.
413 payloadTooLarge Die Nutzdaten sind zu umfangreich.
414 uriTooLong Der URI ist zu lang.
415 unsupportedMediaType Der angegebene Medientyp wird nicht unterstützt.
416 rangeNotSatisfiable Der angeforderte Datenbereich kann nicht erfüllt werden.
417 expectationFailed Der Header „Expectation“ konnte nicht erfüllt werden.
421 misdirectedRequest Eine Antwort für diese Anforderung kann nicht hergestellt werden.
422 unprocessableEntity Die Anforderung enthält semantische Fehler.
423 locked Die Quell- oder Zielressource ist gesperrt.
429 tooManyRequests Zu viele Anforderungen. Versuchen Sie es später erneut.
431 requestHeaderFieldsTooLarge Das Feld mit dem Anforderungsheader ist zu groß.
500 internalServerError Auf dem Server ist ein allgemeiner Fehler aufgetreten.
501 notImplemented Der Server unterstützt die angeforderte Funktion nicht.
502 badGateway Von einem anderen Gateway wurde eine fehlerhafte Antwort empfangen.
503 serviceUnavailable Der Server steht vorübergehend nicht zur Verfügung. Versuchen Sie es später erneut.
504 gatewayTimeout Timeout von einem anderen Gateway empfangen.
507 insufficientStorage Daten für die Anforderung können nicht gespeichert werden.

Innerer Fehlertyp

Das innere Fehlerobjekt enthält fehlerspezifische Details, die dem Entwickler helfen, den aktuellen Fehler zu untersuchen.

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
Eigenschaft Type Beschreibung
code Zeichenfolge Der interne Fehlercode. Enthält einen standardisierten Code basierend auf dem Typ des Fehlers.
message Zeichenfolge Die interne Fehlermeldung. Enthält eine detaillierte Fehlermeldung. In diesem Beispiel hat das Feld includeQRCode den falschen Typ.
target Zeichenfolge Optional. Das Ziel enthält das Feld in der Anforderung, das diesen Fehler verursacht. Dieses Feld ist optional und kann je nach Fehlertyp fehlen.

Interne Fehlercodes

Code BESCHREIBUNG
badOrMissingField wird zurückgegeben, wenn bei der Anforderung Überprüfungsprobleme auftreten. Das Feld target enthält das Feld in der Anforderung, das diesen Fehler verursacht.
notFound wird zurückgegeben, wenn eine Ressource, die der Client anfordert, nicht gefunden wird. Das target Feld enthält den Ressourcennamen bzw. die ID, der bzw. die nicht gefunden wird.
tokenError wird bei Validierungsproblemen bei Token wie JWT o. ä. zurückgegeben. Das Feld target enthält den Tokennamen, der das Problem verursacht, sofern zutreffend.
transientError wird für alle Fälle zurückgegeben, in denen der Client möglicherweise eine erfolgreiche Antwort erhalten kann, wenn die Anforderung später wiederholt wird. Ein gängiges Beispiel für die Rückgabe dieses Codes ist, wenn der HTTP-Code 429 zurückgegeben wird.

Nächste Schritte