Autenticazione e codici di stato HTTP API MFA su richiesta

Le API MFA (Autenticazione e Autenticazione con più fattori su richiesta) per i domini di Identity in IAM sono conformi a REST e utilizzano codici di stato di risposta HTTP standard per indicare un errore.

In questa tabella vengono descritti i diversi codici di stato e i casi d'uso in cui vengono inviati tali codici.

Vedere la sezione Status Code Definitions del protocollo Hypertext Transfer Protocol -- HTTP/1.1.

Codice stato HTTP

caso d'uso

Corpo risposta JSON di esempio

400 Bad Request

Questo codice indica una richiesta non valida. Questo codice viene inviato se un attributo viene fornito con un valore non valido nel payload, il che significa problemi di sintassi.

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

Questo codice indica l'accesso non autorizzato. Viene utilizzato quando requestState non è valido o è scaduto oppure l'ID del file otpCode fornito durante l'autenticazione non è valido.

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

Questo codice viene utilizzato quando la richiesta è sintatticamente corretta, ma semanticamente errata. 422 indica che la richiesta è un'entità non elaborabile. Ad esempio, quando nella richiesta manca l'attributo op, obbligatorio per una determinata azione.

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

Questo codice indica un errore di server interno. Quando si verifica questo errore, la risposta contiene il file ecId e la causa in modo che il client possa contattare l'amministratore per ulteriori dettagli.