Login: Options
3 minute read
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
- 1.1.1. Property
- 1.1. Login: Options > oauth_provider_options > SchemasLoginFirstFactorProviderOption
- 2. Property
Login: Options > options
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 | - |
1.1. Login: Options > oauth_provider_options > 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 | - |
2.1. Login: Options > options > 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"