<title>QWC DB authentication service</title>

QWC DB authentication service

Type: object

root $schema

JSON Schema

Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-db-auth/master/schemas/qwc-db-auth.json"

Reference to JSON schema of this config

root service

Service name

Type: const
Specific value: "db-auth"

root config

Config options

Type: object

root config db_url
Type: string

DB connection URL

root config qwc_config_schema
Type: string

The name of the DB schema which stores the qwc config. Default: qwc_config

root config password_min_length
Type: integer

Min password length. Default: 8

root config password_max_length
Type: integer

Max password length, or -1 to disable. Default: -1

root config password_constraints
Type: array of string

List of RegExes for additional password constraints. Default: []

 No Additional Items

Each item of this array must be:

root config password_constraints password_constraints items
Type: string

root config password_min_constraints
Type: integer

Min number of password_constraints to match for password to be valid. Default: 0

root config password_constraints_message
Type: string

Validation message if password constraints are not met. Default: Password does not match constraints

root config password_expiry
Type: integer

Number of days until password expires, or -1 to disable. Default: -1

root config password_expiry_notice
Type: integer

Show an expiry notice within this number of days before a password expires, or -1 to disable. Default: -1

root config password_update_interval
Type: integer

Min number of seconds before password may be changed again, or -1 to disable. Default: -1

root config password_allow_reuse
Type: boolean

Set whether previous passwords may be reused or not. Default: true

root config user_info_fields
Type: array of string

List of user info fields to include in JWT identity. Default: []

 No Additional Items

Each item of this array must be:

root config user_info_fields user_info_fields items
Type: string

root config logo_image_url
Type: string

URL to a logo image to show in the login form. Default: null

root config background_image_url
Type: string

URL to a background image for the login page. Default: null

root config customstylesheet
Type: string

URL of custom stylesheet. Default: null

root config terms_url
Type: string

URL to terms of use. Default: null

root config login_hint

Login hint text, shown above login form fields. Either a string, or dictionary {"<lang>": "<text>"}. When providing a dictionary, the entry matching the current locale will be searched, with fallback to en if no entry for the current locale exists, and fallback to an empty string if no en entry exists. Default: null

root config login_hint oneOf item 0
Type: string
root config login_hint oneOf item 1
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}$
root config login_hint oneOf item 1 ^[a-z]{2}$
Type: string

root config post_param_login
Type: boolean

Whether 'username' and 'password', and possibly additional parameters, are passed as POST parameters. Additional parameters are appended to the target url query. Default: false

root config max_login_attempts
Type: integer

Maximum login attempts before login is blocked. Default: 20

root config totp_enabled
Type: boolean

Enable two factor authentication using TOTP. Default: false

root config totp_enabled_for_admin
Type: boolean

Whether to enable two-factor authentication using TOTP for admin. Default: false

root config totp_issuer_name
Type: string

Issuer name for QR code URI. Default: QWC Services

root config ip_blacklist_duration
Type: integer

How many seconds an IP will remain in the blacklist. See also ip_blacklist_max_attempt_count. Default: 300

root config ip_blacklist_max_attempt_count
Type: integer

After how many failed login attempts an IP will be blacklisted. Should be less than max_login_attempts. See also ip_blacklist_duration. Default: 10

root config force_password_change_first_login
Type: boolean

Whether to force users to change the password on first login. Default: false