요청 서비스 API 오류 코드

Microsoft Entra 확인된 ID에는 자격 증명을 발급하고 확인할 수 있는 요청 서비스 REST API가 포함되어 있습니다. 이 문서에서는 요청 서비스 API에 대한 오류 코드를 지정합니다.

오류 개체

공개 미리 보기 중에 Request Service API는 다음 형식으로 오류를 반환했습니다.

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

이제 이 형식이 다음으로 변경되어 더 간단한 오류 처리와 문제 해결에 대한 더 나은 지원을 모두 사용할 수 있습니다. 새 형식에서 외부 오류 코드 및 메시지 필드에는 표준화된 값이 있는 반면 innererror 개체는 오류의 원인에 대한 세부 정보를 제공합니다.

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

오류 유형

이제 error 개체가 API 호출에서 반환된 HTTP 상태 코드와 일치하여 개발자가 더 쉽게 오류를 처리할 수 있도록 합니다.

오류 코드 및 메시지

다음은 반환된 다른 HTTP 상태 코드에 매핑되는 가능한 최상위 수준 code 값입니다.

내부 오류 유형

내부 오류 개체에는 현재 오류를 조사하는 데 도움이 되는 개발자에게 유용한 오류 관련 세부 정보가 포함되어 있습니다.

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

내부 오류 코드

다음 단계

• 발급 API 사양
• Presentation API 사양