auth.login_ex_continue ====================== Continue in-progress authentication attempt. This endpoint should be called to continue an auth.login_ex attempt that returned OTP_REQUIRED. This is a convenience wrapper around auth.login_ex for API consumers. params: mechanism: the mechanism by which to continue authentication. Currently the only supported mechanism here is OTP_TOKEN. OTP_TOKEN otp_token: one-time password token. This is only permitted if a previous auth.login_ex call responded with "OTP_REQUIRED". returns: JSON object containing the following keys: `response_type` - will be one of the following: SUCCESS - continued auth was required OTP_REQUIRED - otp token was rejected. API consumer may call this endpoint again with correct OTP token. AUTH_ERR - invalid OTP token submitted too many times. .. raw:: html
OTP token data to continue two-factor authentication flow.
No Additional PropertiesAuthentication mechanism identifier for one-time password tokens.
Specific value:"OTP_TOKEN"
One-time password token for authentication.
Additional options for the authentication process.
No Additional PropertiesWhether to include detailed user information in the authentication response.
Authentication response after continuing with OTP token.
Authentication response type indicating successful login.
Specific value:"SUCCESS"
Authenticated user information or null if not available.
Name of the user.
Full username or comment field.
User home directory.
User command line interpreter.
Numerical user ID of the user.
Numerical group id for the user's primary group.
Optional array of group IDs for groups of which this account is a member. If get_groups is not specified, this value will be null.
Optional SID value for the account that is present if sid_info is specified in payload.
The source for the user account.
The account is local to TrueNAS or provided by a directory service.
Custom user attributes and metadata.
Two-factor authentication configuration for the user.
User privilege and role information.
Array of account attribute names available for this user.
No Additional ItemsAuthentication level achieved (LEVEL1 for password, LEVEL2 for two-factor).
Authentication response type indicating authentication failure.
Specific value:"AUTH_ERR"
Authentication response type indicating the session or token has expired.
Specific value:"EXPIRED"
Authentication response type indicating one-time password is required.
Specific value:"OTP_REQUIRED"
Username for which OTP is required.
Authentication response type indicating redirect is required.
Specific value:"REDIRECT"
Array of URLs to redirect to for authentication completion.
No Additional Items