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

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

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

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

HTTP-Statuscode

Anwendungsfall

JSON-Beispielantworttext

400 Bad Request

Dieser Code weist auf eine fehlerhafte 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 gibt nicht autorisierten Zugriff an. Wird verwendet, wenn die requestState ungültig oder abgelaufen ist oder die ID der bei der Authentifizierung angegebenen otpCode 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: Wenn in der Anforderung das Attribut op fehlt, 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 gibt einen internen Serverfehler an. Wenn dieser Fehler auftritt, enthält die Antwort die ecId und die Ursache, sodass der Client weitere Details an den Administrator senden kann.