config

Version

v1.1.0

Config Type

object (Config)

Config Properties

Property	Type	Required	Nullable	Defined by
account	object	Optional	cannot be null	Config
audit_log	object	Optional	cannot be null	Config
convert_legacy_config	boolean	Optional	cannot be null	Config
database	object	Optional	cannot be null	Config
debug	boolean	Optional	cannot be null	Config
email	object	Optional	cannot be null	Config
email_delivery	object	Optional	cannot be null	Config
emails	object	Optional	cannot be null	Config
log	object	Optional	cannot be null	Config
passcode	object	Optional	cannot be null	Config
passkey	object	Optional	cannot be null	Config
password	object	Optional	cannot be null	Config
rate_limiter	object	Optional	cannot be null	Config
saml	object	Optional	cannot be null	Config
secrets	object	Optional	cannot be null	Config
server	object	Optional	cannot be null	Config
service	object	Optional	cannot be null	Config
session	object	Optional	cannot be null	Config
smtp	object	Optional	cannot be null	Config
third_party	object	Optional	cannot be null	Config
username	object	Optional	cannot be null	Config
webauthn	object	Optional	cannot be null	Config
webhooks	object	Optional	cannot be null	Config

account

account configures settings related to user accounts.

account

• is optional

• cannot be null

account Type

object (account)

audit_log

audit_log configures output and storage modalities of audit logs.

audit_log

• is optional

• cannot be null

audit_log Type

object (audit_log)

convert_legacy_config

convert_legacy_config, if set to true, automatically copies the set values of deprecated configuration options, to new ones. If set to false, these values have to be set manually if non-default values should be used.

convert_legacy_config

• is optional

• cannot be null

convert_legacy_config Type

boolean

database

database configures database connection settings.

database

• is optional

• cannot be null

database Type

object (database)

debug

debug, if set to true, adds additional debugging information to flow API responses.

debug

• is optional

• cannot be null

debug Type

boolean

email

email configures how email addresses of user accounts are acquired and used.

email

• is optional

• cannot be null

email Type

object (email)

email_delivery

email_delivery configures how outgoing mails are delivered.

email_delivery

• is optional

• cannot be null

email_delivery Type

object (email_delivery)

emails

Deprecated. See child properties for suggested replacements.

emails

• is optional

• cannot be null

emails Type

object (emails)

log

log configures application logging.

log

• is optional

• cannot be null

log Type

object (log)

passcode

Deprecated. See child properties for suggested replacements.

passcode

• is optional

• cannot be null

passcode Type

object (passcode)

passkey

passkey configures how passkeys are acquired and used.

passkey

• is optional

• cannot be null

passkey Type

object (passkey)

password

password configures how passwords are acquired and used.

password

• is optional

• cannot be null

password Type

object (password)

rate_limiter

rate_limiter configures rate limits for rate limited API operations and storage modalities for rate limit data.

rate_limiter

• is optional

• cannot be null

rate_limiter Type

object (rate_limiter)

saml

saml configures modalities of SAML (Security Assertion Markup Language) SSO authentication and SAML identity providers.

saml

• is optional

• cannot be null

saml Type

object (saml)

secrets

secrets configures the keys used for cryptographically signing tokens issued by the API.

secrets

• is optional

• cannot be null

secrets Type

object (secrets)

server

server configures address and CORS settings of the public and admin API.

server

• is optional

• cannot be null

server Type

object (server)

service

service configures general service information.

service

• is optional

• cannot be null

service Type

object (service)

session

session configures settings for session JWTs and Cookies issued by the API.

session

• is optional

• cannot be null

session Type

object (session)

smtp

Deprecated. Use email_delivery.smtp instead.

smtp

• is optional

• cannot be null

smtp Type

object (smtp)

third_party

third_party configures the modalities of third party OAuth/OIDC based authentication and available identity providers.

third_party

• is optional

• cannot be null

third_party Type

object (third_party)

username

username configures how usernames of user accounts are acquired and used.

username

• is optional

• cannot be null

username Type

object (username)

webauthn

webauthn configures general settings for communication with the WebAuthentication API.

webauthn

• is optional

• cannot be null

webauthn Type

object (webauthn)

webhooks

webhooks configures HTTP-based callbacks for specific events occurring in the system.

webhooks

• is optional

• cannot be null

webhooks Type

object (webhooks)