Felkoder för api för begärandetjänst

Artikel
12/07/2023

Microsoft Entra – verifierat ID innehåller REST-API:et för begärandetjänsten som gör att du kan utfärda och verifiera en autentiseringsuppgift. Den här artikeln anger felkoderna för API:et för begärandetjänsten.

Felobjekt

Under den offentliga förhandsversionen returnerade API:et för begärandetjänsten fel i följande format.

{
  "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."
  }
}

Det här formatet ändras nu till följande för att möjliggöra både enklare felhantering och bättre stöd för felsökning. I det nya formatet har de yttre felkods - och meddelandefälten innererror standardiserade värden medan objektet ger information om vad som orsakade felet.

{
  "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"
    }
  }
}

Property	Type	Description
`requestId`	sträng	Ett automatiskt genererat begärande-ID.
`date`	datum	Tidpunkten för felet.
`mscv`	sträng	Intern Microsoft-kod.
`error`	Fel	Det yttre felobjektet

Typ av fel

Objektet error matchar nu HTTP-statuskoden som returneras från API-anropet för att möjliggöra enklare felhantering för utvecklare.

Property	Type	Description
`code`	sträng	Returfelkoden som matchar HTTP-statuskoden.
`message`	sträng	Ett standardiserat felmeddelande som också är beroende av http-statuskoden som returneras.
`innererror`	Innererror	Ange information om vad som orsakade felet.

Felkoder och meddelanden

Följande är de möjliga värden på den översta nivån code som mappar till de olika HTTP-statuskoder som returneras.

HTTP-statuskod	kod	meddelande
400	badRequest	Begäran är ogiltig.
401	Obehörig	Den begärda resursen kräver autentisering
403	Förbjudet	Behörigheter som saknas för att uppfylla den här begäran.
404	notFound	Den begärda resursen finns inte.
405	methodNotAllowed	Den begärda metoden tillåts inte för den begärda resursen.
406	notAcceptable	Det begärda svarsformatet stöds inte.
408	requestTimeout	Tidsgränsen för begäran översågs.
409	Konflikt	Servern kan inte uppfylla begäran på grund av en serverkonflikt.
410	Gått	Den begärda resursen är inte längre tillgänglig.
411	contentLengthRequired	Rubriken Innehållslängd saknas.
412	preconditionFailed	En förutsättning för den här begäran misslyckades.
413	payloadTooLarge	Nyttolasten är för stor.
414	uriTooLong	URI:n är för lång.
415	mediatyp som inte stöds	Den angivna medietypen stöds inte.
416	rangeNotSatisfiable	Det begärda dataintervallet kan inte uppfyllas.
417	expectationFailed	Det gick inte att uppfylla expect-huvudet.
421	misdirectedRequest	Det går inte att skapa ett svar för den här begäran.
422	unprocessableEntity	Begäran innehåller semantiska fel.
423	Låst	Käll- eller målresursen är låst.
429	tooManyRequests	För många begäranden, försök igen senare.
431	requestHeaderFieldsTooLarge	Fältet för begärandehuvud är för stort.
500	internalServerError	Ett allmänt fel har uppstått på servern.
501	notImplemented	Servern stöder inte den begärda funktionen.
502	badGateway	dåligt svar från en annan gateway.
503	serviceUnavailable	Servern är tillfälligt otillgänglig. Försök igen senare.
504	gatewayTimeout	Tidsgränsen togs emot från en annan gateway.
507	insufficientStorage	Det går inte att spara data för begäran.

Typ av inre fel

Det inre felobjektet innehåller felspecifik information som är användbar för utvecklaren för att undersöka det aktuella felet.

{
  "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"
    }
  }
}

Property	Type	Description
`code`	sträng	Den interna felkoden. Innehåller en standardiserad kod baserat på typen av fel
`message`	sträng	Det interna felmeddelandet. Innehåller ett detaljerat meddelande om felet. I det här exemplet är fältet `includeQRCode` av fel typ.
`target`	sträng	Valfritt. Målet innehåller fältet i begäran som orsakar det här felet. Det här fältet är valfritt och kanske inte finns, beroende på feltypen.

Inre felkoder

Kod	beskrivning
`badOrMissingField`	returneras när valideringsproblem på begäran inträffar. Fältet `target` innehåller fältet i begäran som orsakar problemet.
`notFound`	returneras när en resurs som klienten begär inte hittas. Fältet `target` innehåller resursnamnet/ID:t som inte hittas.
`tokenError`	returneras för valideringsproblem på token som JWT och liknande. Fältet `target` innehåller det tokennamn som orsakar problemet, när det är tillämpligt.
`transientError`	returneras för alla fall där klienten kan få ett lyckat svar om de försöker begära igen i ett senare skede. Ett vanligt exempel på när den här koden returneras är när en HTTP 429-kod returneras

Dela via