HTTP-Statuscodes für Authentifizierung und On-Demand-MFA-API

Die Authentifizierungs- und On-Demand-MFA-(Multifaktor-Authentifizierung-)APIs für Identitätsdomains in IAM sind REST-konform und verwenden Standard-HTTP-Antwortstatuscodes, um einen Fehler anzuzeigen.

In dieser Tabelle werden die verschiedenen Statusschlüssel und die Anwendungsfälle beschrieben, in denen diese Statusschlüssel gesendet werden.

Weitere Informationen finden Sie im Abschnitt Statuscodedefinitionen des Hypertext Transfer Protocol -- HTTP/1.1.

HTTP-Statuscode

Anwendungsfall

Beispiel für JSON-Antwortbody

400 Bad Request

Dieser Code weist auf eine ungültige Anforderung hin. Dieser Code wird gesendet, wenn ein Attribut mit einem ungültigen Wert in der Payload angegeben wird, was Syntaxprobleme bedeutet.

{
    "status": "failed",
    "ecid": "Suwmo0F0000000000",
    "cause":
            [
                {
                    "message": "Invalid value [EMAILS] for attribute authFactor. One of [USERNAME_PASSWORD,PUSH,TOTP,EMAIL,SMS,BYPASSCODE, SECURITY_QUESTIONS] was expected.",
                    "code": "AUTH-1111"
                }
            ],
    "requestState": "bnJ7Qkz2Vff0RNuxwcJQwnaQFA"
}
401 Unauthorized

Dieser Code weist auf unberechtigten Zugriff hin. Wird verwendet, wenn die requestState ungültig oder abgelaufen ist oder die ID der otpCode, die bei der Authentifizierung angegeben wurde, ungültig ist.

{
    "status": "failed",
    "ecid": "3YkZh1H0000000000",
    "cause":
            [
                {
                    "message": "You entered an incorrect username or password.",
                    "code": "AUTH-3001"
                }
            ],
    "requestState": "b0EYFnXpo"
}
422

Dieser Code wird verwendet, wenn die Anforderung syntaktisch korrekt, aber semantisch falsch ist. 422 bedeutet, dass die Anforderung eine nicht verarbeitbare Entity ist. Beispiel: In der Anforderung fehlt das Attribut op, das für eine bestimmte Aktion erforderlich ist.

{
    "status": "failed",
    "ecid": "KIN^r0J0000000000",
    "nextOp": ["credSubmit"],
    "cause":
            [
                {
                    "message": "Your input request is missing the op attribute, which is mandatory.",
                    "code": "AUTH-1111"
                }
            ],
    "requestState": "b0EYFnLpFWEihmJ6btqTXpo",
    "USERNAME_PASSWORD":
            {
                "credentials": ["username", "password"]
            },
    "nextAuthFactors": ["USERNAME_PASSWORD"]
}
500 Internal Server Error

Dieser Code weist auf einen internen Serverfehler hin. Wenn dieser Fehler auftritt, enthält die Antwort die ecId und die Ursache, damit der Client den Administrator für weitere Details kontaktieren kann.