This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Page Reference

Reference documentation for each template page

1: Dashboard
2: Enroll OTP
3: Enroll WebAuthn
4: Login
5: Login: Enter OTP
6: Login: Enter Password
7: Login: Magic Link
8: Login: Magic Link Sent
9: Login: Options
10: Login: Success
11: Login: TFA Options
12: Login: WebAuthn
13: Reset Password
14: Reset Password: Email Sent
15: Reset Password: Set Password
16: Signup
17: Signup: Create Password
18: Signup: Success
19: style.css
20: Verification Error
21: Verification Success

1 - Dashboard

The main user account dashboard, displaying available authentication options and user session details.

Dashboard

Title: Dashboard


Type	`object`
Required	No
Additional properties	Not allowed

Description: The main user account dashboard, displaying available authentication options and user session details.

Property	Pattern	Type	Deprecated	Definition	Title/Description
- email	No	string	No	-	User Email
- first_factor_option_names	No	object or null	No	-	First Factor Option Names
- first_factor_options	No	array of string or null	No	-	First Factor Options
- second_factor_option_names	No	object or null	No	-	Second Factor Option Names
- second_factor_options	No	array of string or null	No	-	Second Factor Options
- sessions	No	array or null	No	-	User Sessions

1. Property `Dashboard > email`

Title: User Email


Type	`string`
Required	No

Description: The email address of the user.

2. Property `Dashboard > first_factor_option_names`

Title: First Factor Option Names


Type	`object or null`
Required	No

Description: Human-readable names for first factor options.

Property	Pattern	Type	Deprecated	Definition	Title/Description
-	No	string	No	-	-

2.1. Property `Dashboard > first_factor_option_names > additionalProperties`


Type	`string`
Required	No

3. Property `Dashboard > first_factor_options`

Title: First Factor Options


Type	`array of string or null`
Required	No

Description: Available first factor authentication methods.

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
first_factor_options items	-

3.1. Dashboard > first_factor_options > first_factor_options items


Type	`string`
Required	No

4. Property `Dashboard > second_factor_option_names`

Title: Second Factor Option Names


Type	`object or null`
Required	No

Description: Human-readable names for second factor options.

Property	Pattern	Type	Deprecated	Definition	Title/Description
-	No	string	No	-	-

4.1. Property `Dashboard > second_factor_option_names > additionalProperties`


Type	`string`
Required	No

5. Property `Dashboard > second_factor_options`

Title: Second Factor Options


Type	`array of string or null`
Required	No

Description: Available second factor authentication methods.

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
second_factor_options items	-

5.1. Dashboard > second_factor_options > second_factor_options items


Type	`string`
Required	No

6. Property `Dashboard > sessions`

Title: User Sessions


Type	`array or null`
Required	No

Description: Active user sessions with details.

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
SchemasSessionSchema	-

6.1. Dashboard > sessions > SchemasSessionSchema


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/definitions/SchemasSessionSchema

Property	Pattern	Type	Deprecated	Definition	Title/Description
- expires_at	No	string	No	-	Expires At
- ip_address	No	string	No	-	IP Address
- last_user_agent	No	string	No	-	Last User Agent
- session_id	No	string	No	-	Session ID

6.1.1. Property `Dashboard > sessions > sessions items > expires_at`

Title: Expires At


Type	`string`
Required	No

Description: Expiration time of the session.

6.1.2. Property `Dashboard > sessions > sessions items > ip_address`

Title: IP Address


Type	`string`
Required	No

Description: Last known IP address of the session.

6.1.3. Property `Dashboard > sessions > sessions items > last_user_agent`

Title: Last User Agent


Type	`string`
Required	No

Description: User agent of the last request in the session.

6.1.4. Property `Dashboard > sessions > sessions items > session_id`

Title: Session ID


Type	`string`
Required	No

Description: Unique identifier for the session.

2 - Enroll OTP

Enroll a user in One-Time Password (OTP) authentication.

Enroll OTP

Title: Enroll OTP


Type	`object`
Required	No
Additional properties	Not allowed

Description: Enroll a user in One-Time Password (OTP) authentication.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful",
    "otp_secret": "JBSWY3DPEHPK3PXP",
    "otp_url": "otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message
- otp_secret	No	string	No	-	OTP Secret
- otp_url	No	string	No	-	OTP URL

1. Property `Enroll OTP > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Enroll OTP > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

3. Property `Enroll OTP > otp_secret`

Title: OTP Secret


Type	`string`
Required	No

Description: Secret for the OTP authenticator app

4. Property `Enroll OTP > otp_url`

Title: OTP URL


Type	`string`
Required	No

Description: URL to configure the OTP authenticator app

3 - Enroll WebAuthn

The schema for enrolling a user in WebAuthn (Web Authentication) for two-factor authentication.

Enroll WebAuthn

Title: Enroll WebAuthn


Type	`object`
Required	No
Additional properties	Not allowed

Description: The schema for enrolling a user in WebAuthn (Web Authentication) for two-factor authentication.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful",
    "options": "<opaque string to be sent to the browser>"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message
- options	No	string	No	-	WebAuthn Options

1. Property `Enroll WebAuthn > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Enroll WebAuthn > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

3. Property `Enroll WebAuthn > options`

Title: WebAuthn Options


Type	`string`
Required	No

Description: WebAuthn options for the user to enroll a new device

4 - Login

The first step of the login process, where a user enters their email.

Title: Login


Type	`object`
Required	No
Additional properties	Not allowed

Description: The first step of the login process, where a user enters their email.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Login > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Login > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

5 - Login: Enter OTP

The second step of the login process when using OTP (One-Time Password) authentication.

Title: Login: Enter OTP


Type	`object`
Required	No
Additional properties	Not allowed

Description: The second step of the login process when using OTP (One-Time Password) authentication.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Login: Enter OTP > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Login: Enter OTP > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

6 - Login: Enter Password

The second step of the login process when using a password for authentication.

Title: Login: Enter Password


Type	`object`
Required	No
Additional properties	Not allowed

Description: The second step of the login process when using a password for authentication.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Login: Enter Password > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Login: Enter Password > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

7 - Login: Magic Link

The second step of the login process when using a magic link for authentication.

Title: Login: Magic Link


Type	`object`
Required	No
Additional properties	Any type allowed

Description: The second step of the login process when using a magic link for authentication.

8 - Login: Magic Link Sent

The second step of the login process where a magic link has been sent to the user.

Title: Login: Magic Link Sent


Type	`object`
Required	No
Additional properties	Any type allowed

Description: The second step of the login process where a magic link has been sent to the user.

9 - Login: Options

The options available to the user during the second step of the login process.

Title: Login: Options


Type	`object`
Required	No
Additional properties	Not allowed

Description: The options available to the user during the second step of the login process.

Example:

{
    "option_name": {
        "magiclink": "Magic Link",
        "password": "Password"
    },
    "options": [
        "password",
        "magiclink"
    ]
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- oauth_provider_options	No	array	No	-	OAuth Provider Options
- options	No	array or null	No	-	Options

1. Property `Login: Options > oauth_provider_options`

Title: OAuth Provider Options


Type	`array`
Required	No

Description: List of available OAuth provider options for the user to choose from

Example:

{
    "provider_id": "google",
    "provider_image_url": "https://example.com/google.png",
    "provider_name": "Google"
}

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
SchemasLoginFirstFactorProviderOption	-


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/definitions/SchemasLoginFirstFactorProviderOption

Property	Pattern	Type	Deprecated	Definition	Title/Description
- provider_id	No	string	No	-	Provider ID
- provider_image_url	No	string	No	-	Provider Image URL
- provider_name	No	string	No	-	Provider Name

1.1.1. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_id`

Title: Provider ID


Type	`string`
Required	No

Description: Unique identifier for the OAuth provider

Example:

"google"

1.1.2. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_image_url`

Title: Provider Image URL


Type	`string`
Required	No

Description: URL to the image representing the OAuth provider

Example:

"https://example.com/google.png"

1.1.3. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_name`

Title: Provider Name


Type	`string`
Required	No

Description: Human-readable name for the OAuth provider

Example:

"Google"

2. Property `Login: Options > options`

Title: Options


Type	`array or null`
Required	No

Description: List of available options for the user to choose from

Example:

{
    "option_id": "password",
    "option_name": "Password"
}

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
SchemasLoginFirstFactorOption	-


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/definitions/SchemasLoginFirstFactorOption

Property	Pattern	Type	Deprecated	Definition	Title/Description
- option_id	No	string	No	-	Option ID
- option_name	No	string	No	-	Option Name

2.1.1. Property `Login: Options > options > options items > option_id`

Title: Option ID


Type	`string`
Required	No

Description: Unique identifier for the login option

Example:

"password"

2.1.2. Property `Login: Options > options > options items > option_name`

Title: Option Name


Type	`string`
Required	No

Description: Human-readable name for the login option

Example:

"Password"

10 - Login: Success

A successful login.

Title: Login: Success


Type	`object`
Required	No
Additional properties	Any type allowed

Description: A successful login.

11 - Login: TFA Options

Display available TFA (Two-Factor Authentication) options for a user during login.

Title: Login: TFA Options


Type	`object`
Required	No
Additional properties	Not allowed

Description: Display available TFA (Two-Factor Authentication) options for a user during login.

Example:

{
    "option_name": {
        "otp": "One-Time Password",
        "webauthn": "WebAuthn"
    },
    "options": [
        "otp",
        "webauthn"
    ]
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- option_name	No	object or null	No	-	TFA Option Names
- options	No	array of string or null	No	-	TFA Options

1. Property `Login: TFA Options > option_name`

Title: TFA Option Names


Type	`object or null`
Required	No

Description: Map of TFA option IDs to human-readable names

Example:

{
    "otp": "One-Time Password",
    "webauthn": "WebAuthn"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
-	No	string	No	-	-

1.1. Property `Login: TFA Options > option_name > additionalProperties`


Type	`string`
Required	No

2. Property `Login: TFA Options > options`

Title: TFA Options


Type	`array of string or null`
Required	No

Description: List of available TFA option IDs for the user

Examples:

"otp"

"webauthn"

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
options items	-


Type	`string`
Required	No

12 - Login: WebAuthn

The second step of the login process when using WebAuthn for authentication.

Title: Login: WebAuthn


Type	`object`
Required	No
Additional properties	Not allowed

Description: The second step of the login process when using WebAuthn for authentication.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Login: WebAuthn > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Login: WebAuthn > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

13 - Reset Password

The first step of the password reset process where a user requests a password reset link.

Reset Password

Title: Reset Password


Type	`object`
Required	No
Additional properties	Any type allowed

Description: The first step of the password reset process where a user requests a password reset link.

14 - Reset Password: Email Sent

A response indicating that a password reset link has been sent to the user’s email.

Reset Password: Email Sent

Title: Reset Password: Email Sent


Type	`object`
Required	No
Additional properties	Any type allowed

Description: A response indicating that a password reset link has been sent to the user’s email.

15 - Reset Password: Set Password

Schema for setting a new password during the password reset process.

Reset Password: Set Password

Title: Reset Password: Set Password


Type	`object`
Required	No
Additional properties	Not allowed

Description: Schema for setting a new password during the password reset process.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful",
    "reset_token": "abc123xyz"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message
- reset_token	No	string	No	-	Reset Token

1. Property `Reset Password: Set Password > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Reset Password: Set Password > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

3. Property `Reset Password: Set Password > reset_token`

Title: Reset Token


Type	`string`
Required	No

Description: The token used to verify the password reset request

Example:

"abc123xyz"

16 - Signup

Step 1 in the signup process where a new user registers with their email.

Title: Signup


Type	`object`
Required	No
Additional properties	Not allowed

Description: Step 1 in the signup process where a new user registers with their email.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Signup > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Signup > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

17 - Signup: Create Password

Create a password during the signup process.

Title: Signup: Create Password


Type	`object`
Required	No
Additional properties	Not allowed

Description: Create a password during the signup process.

Example:

{
    "error": "Invalid credentials",
    "message": "Logout successful"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
- error	No	string	No	-	Error
- message	No	string	No	-	Message

1. Property `Signup: Create Password > error`

Title: Error


Type	`string`
Required	No

Description: Human-readable message to be displayed about an error that occurred

Example:

"Invalid credentials"

2. Property `Signup: Create Password > message`

Title: Message


Type	`string`
Required	No

Description: Human-readable message to display to the user. It being present is not indicative of an error

Example:

"Logout successful"

18 - Signup: Success

A successful signup response.

Title: Signup: Success


Type	`object`
Required	No
Additional properties	Any type allowed

Description: A successful signup response.

19 - style.css

The global style.css file.

style.css

Title: style.css


Type	`object`
Required	No
Additional properties	Any type allowed

Description: The global style.css file.

20 - Verification Error

An error response during the verification process.

Verification Error

Title: Verification Error


Type	`object`
Required	No
Additional properties	Any type allowed

Description: An error response during the verification process.

21 - Verification Success

A successful verification response.

Verification Success

Title: Verification Success


Type	`object`
Required	No
Additional properties	Any type allowed

Description: A successful verification response.

Page Reference

1 - Dashboard

Dashboard

1. Property Dashboard > email

2. Property Dashboard > first_factor_option_names

2.1. Property Dashboard > first_factor_option_names > additionalProperties

3. Property Dashboard > first_factor_options

3.1. Dashboard > first_factor_options > first_factor_options items

4. Property Dashboard > second_factor_option_names

4.1. Property Dashboard > second_factor_option_names > additionalProperties

5. Property Dashboard > second_factor_options

5.1. Dashboard > second_factor_options > second_factor_options items

6. Property Dashboard > sessions

6.1. Dashboard > sessions > SchemasSessionSchema

6.1.1. Property Dashboard > sessions > sessions items > expires_at

6.1.2. Property Dashboard > sessions > sessions items > ip_address

6.1.3. Property Dashboard > sessions > sessions items > last_user_agent

6.1.4. Property Dashboard > sessions > sessions items > session_id

2 - Enroll OTP

Enroll OTP

1. Property Enroll OTP > error

2. Property Enroll OTP > message

3. Property Enroll OTP > otp_secret

4. Property Enroll OTP > otp_url

3 - Enroll WebAuthn

Enroll WebAuthn

1. Property Enroll WebAuthn > error

2. Property Enroll WebAuthn > message

3. Property Enroll WebAuthn > options

4 - Login

Login

1. Property Login > error

2. Property Login > message

5 - Login: Enter OTP

Login: Enter OTP

1. Property Login: Enter OTP > error

2. Property Login: Enter OTP > message

6 - Login: Enter Password

Login: Enter Password

1. Property Login: Enter Password > error

2. Property Login: Enter Password > message

7 - Login: Magic Link

Login: Magic Link

8 - Login: Magic Link Sent

Login: Magic Link Sent

9 - Login: Options

Login: Options

1. Property Login: Options > oauth_provider_options

1.1. Login: Options > oauth_provider_options > SchemasLoginFirstFactorProviderOption

1.1.1. Property Login: Options > oauth_provider_options > oauth_provider_options items > provider_id

1.1.2. Property Login: Options > oauth_provider_options > oauth_provider_options items > provider_image_url

1.1.3. Property Login: Options > oauth_provider_options > oauth_provider_options items > provider_name

2. Property Login: Options > options

2.1. Login: Options > options > SchemasLoginFirstFactorOption

2.1.1. Property Login: Options > options > options items > option_id

2.1.2. Property Login: Options > options > options items > option_name

10 - Login: Success

Login: Success

11 - Login: TFA Options

Login: TFA Options

1. Property Login: TFA Options > option_name

1.1. Property Login: TFA Options > option_name > additionalProperties

2. Property Login: TFA Options > options

2.1. Login: TFA Options > options > options items

12 - Login: WebAuthn

Login: WebAuthn

1. Property Login: WebAuthn > error

2. Property Login: WebAuthn > message

13 - Reset Password

Reset Password

14 - Reset Password: Email Sent

Reset Password: Email Sent

15 - Reset Password: Set Password

Reset Password: Set Password

1. Property Reset Password: Set Password > error

2. Property Reset Password: Set Password > message

3. Property Reset Password: Set Password > reset_token

16 - Signup

Signup

1. Property Signup > error

1. Property `Dashboard > email`

2. Property `Dashboard > first_factor_option_names`

2.1. Property `Dashboard > first_factor_option_names > additionalProperties`

3. Property `Dashboard > first_factor_options`

4. Property `Dashboard > second_factor_option_names`

4.1. Property `Dashboard > second_factor_option_names > additionalProperties`

5. Property `Dashboard > second_factor_options`

6. Property `Dashboard > sessions`

6.1.1. Property `Dashboard > sessions > sessions items > expires_at`

6.1.2. Property `Dashboard > sessions > sessions items > ip_address`

6.1.3. Property `Dashboard > sessions > sessions items > last_user_agent`

6.1.4. Property `Dashboard > sessions > sessions items > session_id`

1. Property `Enroll OTP > error`

2. Property `Enroll OTP > message`

3. Property `Enroll OTP > otp_secret`

4. Property `Enroll OTP > otp_url`

1. Property `Enroll WebAuthn > error`

2. Property `Enroll WebAuthn > message`

3. Property `Enroll WebAuthn > options`

1. Property `Login > error`

2. Property `Login > message`

1. Property `Login: Enter OTP > error`

2. Property `Login: Enter OTP > message`

1. Property `Login: Enter Password > error`

2. Property `Login: Enter Password > message`

1. Property `Login: Options > oauth_provider_options`

1.1.1. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_id`

1.1.2. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_image_url`

1.1.3. Property `Login: Options > oauth_provider_options > oauth_provider_options items > provider_name`

2. Property `Login: Options > options`

2.1.1. Property `Login: Options > options > options items > option_id`

2.1.2. Property `Login: Options > options > options items > option_name`

1. Property `Login: TFA Options > option_name`

1.1. Property `Login: TFA Options > option_name > additionalProperties`

2. Property `Login: TFA Options > options`

1. Property `Login: WebAuthn > error`

2. Property `Login: WebAuthn > message`

1. Property `Reset Password: Set Password > error`

2. Property `Reset Password: Set Password > message`

3. Property `Reset Password: Set Password > reset_token`

1. Property `Signup > error`

2. Property `Signup > message`

1. Property `Signup: Create Password > error`

2. Property `Signup: Create Password > message`