Microsoft Entra の検証済み ID には、資格情報を発行して確認できる要求サービス REST API が含まれています。 この記事では、要求サービス API のエラー コードを指定します。
Error オブジェクト
パブリック プレビュー中に、要求サービス 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"
}
}
}
| 財産 | 種類 | 形容 |
|---|---|---|
requestId |
糸 | 自動生成された要求 ID。 |
date |
日付 | エラーの時刻。 |
mscv |
糸 | Microsoft の内部コード。 |
error |
エラー | 外部エラー オブジェクト |
エラーの種類
error オブジェクトは、API 呼び出しから返された HTTP 状態コードと一致し、開発者にとってエラー処理が容易になりました。
| 財産 | 種類 | 形容 |
|---|---|---|
code |
糸 | HTTP 状態コードと一致するリターン エラー コード。 |
message |
糸 | 返される HTTP 状態コードにも依存する標準化されたエラー メッセージ。 |
innererror |
Innererror | エラーの原因の詳細を指定します。 |
エラー コードとメッセージ
返されるさまざまな HTTP 状態コードにマップされる最上位レベルの code 値を次に示します。
| HTTP 状態コード | コード | メッセージ |
|---|---|---|
| 400 | badRequest | 要求が無効です。 |
| 401 | 不正 | 要求されたリソースには認証が必要です |
| 403 | 禁じられた | この要求を満たすアクセス許可がありません。 |
| 404 | notFound | 要求されたリソースが存在しません。 |
| 405 | methodNotAllowed | 要求されたメソッドは、要求されたリソースでは許可されません。 |
| 406 | notAcceptable | 要求された応答形式はサポートされていません。 |
| 408 | リクエストタイムアウト | 要求がタイムアウトしました。 |
| 409 | 葛藤 | サーバーの競合が原因で、サーバーが要求を満たすことはできません。 |
| 410 | 行って | 要求されたリソースは使用できなくなりました。 |
| 411 | contentLengthRequired | Content-Length ヘッダーがありません。 |
| 412 | preconditionFailed | この要求の前提条件が失敗しました。 |
| 413 | payloadTooLarge | ペイロードが大きすぎます。 |
| 414 | uriTooLong | URI が長すぎます。 |
| 415 | unsupportedMediaType | 指定されたメディアの種類はサポートされていません。 |
| 416 | rangeNotSatisfiable | 要求されたデータの要求された範囲を満たすことはできません。 |
| 417 | expectationFailed | 予期されるヘッダーを満たすことができませんでした。 |
| 421 | misdirectedRequest | この要求の応答を生成できません。 |
| 422 | unprocessableEntity | 要求にセマンティック エラーが含まれています。 |
| 423 | 締まる | ソースリソースまたは移行先リソースがロックされています。 |
| 429 | tooManyRequests | 要求が多すぎます。後でもう一度やり直してください。 |
| 431 | requestHeaderFieldsTooLarge | 要求ヘッダー フィールドが大きすぎます。 |
| 500 | internalServerError | サーバーで一般的なエラーが発生しました。 |
| 501 | notImplemented | サーバーは、要求された関数をサポートしていません。 |
| 502 | badGateway | 別のゲートウェイから受信した応答が正しくありません。 |
| 503 | serviceUnavailable | サーバーは一時的に使用できません。後でもう一度お試しください。 |
| 504 | gatewayTimeout | 別のゲートウェイから受信したタイムアウト。 |
| 507 | insufficientStorage | 要求のデータを保存できません。 |
内部エラーの種類
内部エラー オブジェクトには、開発者が現在のエラーの調査に役立つエラー固有の詳細が含まれています。
{
"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"
}
}
}
| 財産 | 種類 | 形容 |
|---|---|---|
code |
糸 | 内部エラー コード。 エラーの種類に基づいて標準化されたコードが含まれています |
message |
糸 | 内部エラー メッセージ。 エラーの詳細なメッセージが含まれています。 この例では、includeQRCode フィールドの型が正しくありません。 |
target |
糸 | 随意。 ターゲットには、このエラーの原因となっている要求のフィールドが含まれています。 このフィールドは省略可能であり、エラーの種類によっては存在しない場合があります。 |
内部エラー コード
| コード | 形容 |
|---|---|
badOrMissingField |
要求の検証の問題が発生したときに返されます。
target フィールドには、問題の原因となっている要求のフィールドが含まれています。 |
notFound |
クライアントが要求しているリソースが見つからない場合に返されます。
target フィールドには、見つからないリソース名/ID が含まれています。 |
tokenError |
JSON Web トークン (JWT) などのトークンに関する検証の問題に対して返されます。
target フィールドには、問題の原因となったトークン名が含まれます (該当する場合)。 |
transientError |
は、クライアントが後の段階で要求を再試行した場合に正常な応答を取得できる可能性があるすべての場合に返されます。 このコードが返される一般的な例は、HTTP 429 コードが返されたときです |