# 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.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: login_data

#### login_data

Type: object

OTP token data to continue two-factor authentication flow.

No Additional Properties

##

#### Mechanism

Type: const

Authentication mechanism identifier for one-time password tokens.

Specific value: `"OTP_TOKEN"`

##

#### Otp Token

Type: string

One-time password token for authentication.

##

#### AuthCommonOptions

Type: object Default: {"user_info": true}

Additional options for the authentication process.

No Additional Properties

##

#### User Info

Type: boolean Default: true

Whether to include detailed user information in the authentication response.

##

#### Result

Authentication response after continuing with OTP token.

## One of

#### AuthRespSuccess

Type: object
No Additional Properties

##

#### Response Type

Type: const

Authentication response type indicating successful login.

Specific value: `"SUCCESS"`

##

Authenticated user information or `null` if not available.

## Any of

#### AuthUserInfo

Type: object
No Additional Properties

##

#### Pw Name

Type: string

Name of the user.

##

#### Pw Gecos

Type: string

Full username or comment field.

##

#### Pw Dir

Type: string

User home directory.

##

#### Pw Shell

Type: string

User command line interpreter.

##

#### Pw Uid

Type: integer

Numerical user ID of the user.

##

#### Pw Gid

Type: integer

Numerical group id for the user's primary group.

##

#### Grouplist

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`.

## Any of

Type: array of integer
No Additional Items

##### Each item of this array must be:

Type: integer
Type: null

##

#### Sid

Optional SID value for the account that is present if `sid_info` is specified in payload.

## Any of

Type: string
Type: null

##

#### Source

Type: enum (of string)

The source for the user account.

##### Must be one of:

- "LOCAL"
- "ACTIVEDIRECTORY"
- "LDAP"

##

#### Local

Type: boolean

The account is local to TrueNAS or provided by a directory service.

##

#### Attributes

Type: object

Custom user attributes and metadata.

##

#### Two Factor Config

Type: object

Two-factor authentication configuration for the user.

##

#### Privilege

Type: object

User privilege and role information.

##

#### Account Attributes

Type: array of string

Array of account attribute names available for this user.

No Additional Items

##### Each item of this array must be:

Type: string
Type: null

##

#### Authenticator

Type: enum (of string)

Authentication level achieved (LEVEL1 for password, LEVEL2 for two-factor).

##### Must be one of:

- "LEVEL_1"
- "LEVEL_2"

#### AuthRespAuthErr

Type: object
No Additional Properties

##

#### Response Type

Type: const

Authentication response type indicating authentication failure.

Specific value: `"AUTH_ERR"`

#### AuthRespExpired

Type: object
No Additional Properties

##

#### Response Type

Type: const

Authentication response type indicating the session or token has expired.

Specific value: `"EXPIRED"`

#### AuthRespOTPRequired

Type: object
No Additional Properties

##

#### Response Type

Type: const

Authentication response type indicating one-time password is required.

Specific value: `"OTP_REQUIRED"`

##

#### Username

Type: string

Username for which OTP is required.

#### AuthRespAuthRedirect

Type: object
No Additional Properties

##

#### Response Type

Type: const

Authentication response type indicating redirect is required.

Specific value: `"REDIRECT"`

##

#### Urls

Type: array of string

Array of URLs to redirect to for authentication completion.

No Additional Items

##### Each item of this array must be:

Type: string

Required roles: