Skip to content

Navigation Menu

Appearance settings

Explore
By company size
By use case
By industry
View all solutions
Topics
- AI
- DevOps
- Security
- Software Development
- View all
Explore
- GitHub Sponsors
  Fund open source developers
- The ReadME Project
  GitHub community articles
Repositories
- Enterprise platform
  AI-powered developer platform
Available add-ons
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

Appearance settings

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

teamhanko / hanko Public

Notifications You must be signed in to change notification settings
Fork 964
Star 8.1k

Code
Issues 43
Pull requests 24
Discussions
Actions
Projects 1
Wiki
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Discussions
Actions
Projects
Wiki
Security
Insights

config properties email properties optional

Jump to bottom

GitHub Action edited this page May 21, 2025 · 19 revisions

Version

v2.1.0

optional Type

boolean

Toggle table of contents Pages 391

Home
config
config properties account
config properties account properties allow_deletion
config properties account properties allow_signup
config properties audit_log
config properties audit_log properties console_output
config properties audit_log properties console_output properties enabled
config properties audit_log properties console_output properties output
config properties audit_log properties mask
config properties audit_log properties retention
config properties audit_log properties storage
config properties audit_log properties storage properties enabled
config properties convert_legacy_config
config properties convert_legacy_server_side_session_config
config properties database
config properties database properties database
config properties database properties dialect
config properties database properties host
config properties database properties password
config properties database properties port
config properties database properties url
config properties database properties user
config properties debug
config properties email
config properties email properties acquire_on_login
config properties email properties acquire_on_registration
config properties email properties enabled
config properties email properties limit
config properties email properties max_length
config properties email properties optional
- Version
- optional Type
config properties email properties passcode_ttl
config properties email properties require_verification
config properties email properties use_as_login_identifier
config properties email properties use_for_authentication
config properties email_delivery
config properties email_delivery properties enabled
config properties email_delivery properties from_address
config properties email_delivery properties from_name
config properties email_delivery properties smtp
config properties email_delivery properties smtp properties host
config properties email_delivery properties smtp properties password
config properties email_delivery properties smtp properties port
config properties email_delivery properties smtp properties user
config properties emails
config properties emails properties max_num_of_addresses
config properties emails properties require_verification
config properties log
config properties log properties log_health_and_metrics
config properties mfa
config properties mfa properties acquire_on_login
config properties mfa properties acquire_on_registration
config properties mfa properties device_trust_cookie_name
config properties mfa properties device_trust_duration
config properties mfa properties device_trust_policy
config properties mfa properties device_trust_policy metaenum
config properties mfa properties enabled
config properties mfa properties optional
config properties mfa properties security_keys
config properties mfa properties security_keys properties attestation_preference
config properties mfa properties security_keys properties authenticator_attachment
config properties mfa properties security_keys properties enabled
config properties mfa properties security_keys properties limit
config properties mfa properties security_keys properties user_verification
config properties mfa properties totp
config properties mfa properties totp properties enabled
config properties passcode
config properties passcode properties ttl
config properties passkey
config properties passkey properties acquire_on_login
config properties passkey properties acquire_on_login metaenum
config properties passkey properties acquire_on_registration
config properties passkey properties acquire_on_registration metaenum
config properties passkey properties attestation_preference
config properties passkey properties attestation_preference metaenum
config properties passkey properties enabled
config properties passkey properties limit
config properties passkey properties optional
config properties passkey properties user_verification
config properties passkey properties user_verification metaenum
config properties password
config properties password properties acquire_on_login
config properties password properties acquire_on_login metaenum
config properties password properties acquire_on_registration
config properties password properties acquire_on_registration metaenum
config properties password properties enabled
config properties password properties min_length
config properties password properties min_password_length
config properties password properties optional
config properties password properties recovery
config properties privacy
config properties privacy properties only_show_actual_login_methods
config properties privacy properties show_account_existence_hints
config properties rate_limiter
config properties rate_limiter properties enabled
config properties rate_limiter properties otp_limits
config properties rate_limiter properties otp_limits properties interval
config properties rate_limiter properties otp_limits properties tokens
config properties rate_limiter properties passcode_limits
config properties rate_limiter properties passcode_limits properties interval
config properties rate_limiter properties passcode_limits properties tokens
config properties rate_limiter properties password_limits
config properties rate_limiter properties password_limits properties interval
config properties rate_limiter properties password_limits properties tokens
config properties rate_limiter properties redis_config
config properties rate_limiter properties redis_config properties address
config properties rate_limiter properties redis_config properties password
config properties rate_limiter properties store
config properties rate_limiter properties token_limits
config properties rate_limiter properties token_limits properties interval
config properties rate_limiter properties token_limits properties tokens
config properties saml
config properties saml properties allowed_redirect_urls
config properties saml properties allowed_redirect_urls items
config properties saml properties audience_uri
config properties saml properties default_redirect_url
config properties saml properties enabled
config properties saml properties endpoint_url
config properties saml properties identity_providers
config properties saml properties identity_providers items
config properties saml properties identity_providers items properties attribute_map
config properties saml properties identity_providers items properties attribute_map properties birthdate
config properties saml properties identity_providers items properties attribute_map properties email
config properties saml properties identity_providers items properties attribute_map properties email_verified
config properties saml properties identity_providers items properties attribute_map properties family_name
config properties saml properties identity_providers items properties attribute_map properties gender
config properties saml properties identity_providers items properties attribute_map properties given_name
config properties saml properties identity_providers items properties attribute_map properties locale
config properties saml properties identity_providers items properties attribute_map properties middle_name
config properties saml properties identity_providers items properties attribute_map properties name
config properties saml properties identity_providers items properties attribute_map properties nickname
config properties saml properties identity_providers items properties attribute_map properties phone
config properties saml properties identity_providers items properties attribute_map properties phone_verified
config properties saml properties identity_providers items properties attribute_map properties picture
config properties saml properties identity_providers items properties attribute_map properties preferred_username
config properties saml properties identity_providers items properties attribute_map properties profile
config properties saml properties identity_providers items properties attribute_map properties updated_at
config properties saml properties identity_providers items properties attribute_map properties website
config properties saml properties identity_providers items properties attribute_map properties zone_info
config properties saml properties identity_providers items properties domain
config properties saml properties identity_providers items properties enabled
config properties saml properties identity_providers items properties metadata_url
config properties saml properties identity_providers items properties name
config properties saml properties identity_providers items properties skip_email_verification
config properties saml properties options
config properties saml properties options properties allow_missing_attributes
config properties saml properties options properties force_login
config properties saml properties options properties sign_authn_requests
config properties saml properties options properties skip_signature_validation
config properties saml properties options properties validate_encryption_cert
config properties secrets
config properties secrets properties keys
config properties secrets properties keys keys
config properties server
config properties server properties admin
config properties server properties admin properties address
config properties server properties admin properties cors
config properties server properties admin properties cors properties allow_origins
config properties server properties admin properties cors properties allow_origins items
config properties server properties admin properties cors properties unsafe_wildcard_origin_allowed
config properties server properties public
config properties server properties public properties address
config properties server properties public properties cors
config properties server properties public properties cors properties allow_origins
config properties server properties public properties cors properties allow_origins items
config properties server properties public properties cors properties unsafe_wildcard_origin_allowed
config properties service
config properties service properties name
config properties session
config properties session properties acquire_ip_address
config properties session properties acquire_user_agent
config properties session properties allow_revocation
config properties session properties audience
config properties session properties audience items
config properties session properties cookie
config properties session properties cookie properties domain
config properties session properties cookie properties http_only
config properties session properties cookie properties name
config properties session properties cookie properties retention
config properties session properties cookie properties retention metaenum
config properties session properties cookie properties same_site
config properties session properties cookie properties secure
config properties session properties enable_auth_token_header
config properties session properties issuer
config properties session properties jwt_template
config properties session properties jwt_template properties claims
config properties session properties lifespan
config properties session properties limit
config properties session properties server_side
config properties session properties server_side properties enabled
config properties session properties server_side properties limit
config properties session properties show_on_profile
config properties smtp
config properties smtp properties host
config properties smtp properties password
config properties smtp properties port
config properties smtp properties user
config properties third_party
config properties third_party else
config properties third_party if
config properties third_party if allof 0
config properties third_party if allof 0 properties
config properties third_party if allof 0 properties providers
config properties third_party if allof 0 properties providers patternproperties
config properties third_party if allof 0 properties providers patternproperties
config properties third_party if allof 0 properties providers patternproperties properties
config properties third_party if allof 0 properties providers patternproperties properties enabled
config properties third_party if allof 0 properties providers patternproperties properties enabled anyof 0
config properties third_party if allof 0 properties providers patternproperties properties enabled anyof 1
config properties third_party if allof 1
config properties third_party if allof 1 properties
config properties third_party if allof 1 properties custom_providers
config properties third_party if allof 1 properties custom_providers additionalproperties
config properties third_party if allof 1 properties custom_providers additionalproperties properties
config properties third_party if allof 1 properties custom_providers additionalproperties properties enabled
config properties third_party if allof 1 properties custom_providers additionalproperties properties enabled anyof 0
config properties third_party if allof 1 properties custom_providers additionalproperties properties enabled anyof 1
config properties third_party properties allowed_redirect_urls
config properties third_party properties allowed_redirect_urls items
config properties third_party properties custom_providers
config properties third_party properties custom_providers custom_provider
config properties third_party properties custom_providers custom_provider else
config properties third_party properties custom_providers custom_provider else else
config properties third_party properties custom_providers custom_provider else if
config properties third_party properties custom_providers custom_provider else if properties
config properties third_party properties custom_providers custom_provider else if properties use_discovery
config properties third_party properties custom_providers custom_provider else if properties use_discovery anyof 0
config properties third_party properties custom_providers custom_provider else if properties use_discovery anyof 1
config properties third_party properties custom_providers custom_provider else then
config properties third_party properties custom_providers custom_provider if
config properties third_party properties custom_providers custom_provider if properties
config properties third_party properties custom_providers custom_provider if properties enabled
config properties third_party properties custom_providers custom_provider if properties enabled anyof 0
config properties third_party properties custom_providers custom_provider if properties enabled anyof 1
config properties third_party properties custom_providers custom_provider properties allow_linking
config properties third_party properties custom_providers custom_provider properties attribute_mapping
config properties third_party properties custom_providers custom_provider properties attribute_mapping additionalproperties
config properties third_party properties custom_providers custom_provider properties authorization_endpoint
config properties third_party properties custom_providers custom_provider properties client_id
config properties third_party properties custom_providers custom_provider properties display_name
config properties third_party properties custom_providers custom_provider properties enabled
config properties third_party properties custom_providers custom_provider properties issuer
config properties third_party properties custom_providers custom_provider properties scopes
config properties third_party properties custom_providers custom_provider properties scopes items
config properties third_party properties custom_providers custom_provider properties secret
config properties third_party properties custom_providers custom_provider properties token_endpoint
config properties third_party properties custom_providers custom_provider properties use_discovery
config properties third_party properties custom_providers custom_provider properties userinfo_endpoint
config properties third_party properties custom_providers custom_provider then
config properties third_party properties default_redirect_url
config properties third_party properties error_redirect_url
config properties third_party properties providers
config properties third_party properties providers properties provider
config properties third_party properties providers properties provider 1
config properties third_party properties providers properties provider 1 else
config properties third_party properties providers properties provider 1 if
config properties third_party properties providers properties provider 1 if properties
config properties third_party properties providers properties provider 1 if properties enabled
config properties third_party properties providers properties provider 1 properties allow_linking
config properties third_party properties providers properties provider 1 properties client_id
config properties third_party properties providers properties provider 1 properties enabled
config properties third_party properties providers properties provider 1 properties secret
config properties third_party properties providers properties provider 1 then
config properties third_party properties providers properties provider 2
config properties third_party properties providers properties provider 2 else
config properties third_party properties providers properties provider 2 if
config properties third_party properties providers properties provider 2 if properties
config properties third_party properties providers properties provider 2 if properties enabled
config properties third_party properties providers properties provider 2 properties allow_linking
config properties third_party properties providers properties provider 2 properties client_id
config properties third_party properties providers properties provider 2 properties enabled
config properties third_party properties providers properties provider 2 properties secret
config properties third_party properties providers properties provider 2 then
config properties third_party properties providers properties provider 3
config properties third_party properties providers properties provider 3 else
config properties third_party properties providers properties provider 3 if
config properties third_party properties providers properties provider 3 if properties
config properties third_party properties providers properties provider 3 if properties enabled
config properties third_party properties providers properties provider 3 properties allow_linking
config properties third_party properties providers properties provider 3 properties client_id
config properties third_party properties providers properties provider 3 properties enabled
config properties third_party properties providers properties provider 3 properties secret
config properties third_party properties providers properties provider 3 then
config properties third_party properties providers properties provider 4
config properties third_party properties providers properties provider 4 else
config properties third_party properties providers properties provider 4 if
config properties third_party properties providers properties provider 4 if properties
config properties third_party properties providers properties provider 4 if properties enabled
config properties third_party properties providers properties provider 4 properties allow_linking
config properties third_party properties providers properties provider 4 properties client_id
config properties third_party properties providers properties provider 4 properties enabled
config properties third_party properties providers properties provider 4 properties secret
config properties third_party properties providers properties provider 4 then
config properties third_party properties providers properties provider 5
config properties third_party properties providers properties provider 5 else
config properties third_party properties providers properties provider 5 if
config properties third_party properties providers properties provider 5 if properties
config properties third_party properties providers properties provider 5 if properties enabled
config properties third_party properties providers properties provider 5 properties allow_linking
config properties third_party properties providers properties provider 5 properties client_id
config properties third_party properties providers properties provider 5 properties enabled
config properties third_party properties providers properties provider 5 properties secret
config properties third_party properties providers properties provider 5 then
config properties third_party properties providers properties provider 6
config properties third_party properties providers properties provider 6 else
config properties third_party properties providers properties provider 6 if
config properties third_party properties providers properties provider 6 if properties
config properties third_party properties providers properties provider 6 if properties enabled
config properties third_party properties providers properties provider 6 properties allow_linking
config properties third_party properties providers properties provider 6 properties client_id
config properties third_party properties providers properties provider 6 properties enabled
config properties third_party properties providers properties provider 6 properties secret
config properties third_party properties providers properties provider 6 then
config properties third_party properties providers properties provider else
config properties third_party properties providers properties provider if
config properties third_party properties providers properties provider if properties
config properties third_party properties providers properties provider if properties enabled
config properties third_party properties providers properties provider properties allow_linking
config properties third_party properties providers properties provider properties client_id
config properties third_party properties providers properties provider properties enabled
config properties third_party properties providers properties provider properties secret
config properties third_party properties providers properties provider then
config properties third_party properties redirect_url
config properties third_party then
config properties username
config properties username properties acquire_on_login
config properties username properties acquire_on_registration
config properties username properties enabled
config properties username properties max_length
config properties username properties min_length
config properties username properties optional
config properties username properties use_as_login_identifier
config properties webauthn
config properties webauthn properties relying_party
config properties webauthn properties relying_party properties display_name
config properties webauthn properties relying_party properties id
config properties webauthn properties relying_party properties origins
config properties webauthn properties relying_party properties origins items
config properties webauthn properties timeout
config properties webauthn properties timeouts
config properties webauthn properties timeouts properties login
config properties webauthn properties timeouts properties registration
config properties webauthn properties user_verification
config properties webhooks
config properties webhooks properties allow_time_expiration
config properties webhooks properties enabled
config properties webhooks properties hooks
config properties webhooks properties hooks hooks
config properties webhooks properties hooks hooks properties callback
config properties webhooks properties hooks hooks properties events
config properties webhooks properties hooks hooks properties events events
config properties webhooks properties hooks hooks properties events events metaenum
user_import
user_import importentry
user_import importentry properties created_at
user_import importentry properties emails
user_import importentry properties emails importemail
user_import importentry properties emails importemail properties address
user_import importentry properties emails importemail properties is_primary
user_import importentry properties emails importemail properties is_verified
user_import importentry properties otp_secret
user_import importentry properties otp_secret properties created_at
user_import importentry properties otp_secret properties secret
user_import importentry properties otp_secret properties updated_at
user_import importentry properties password
user_import importentry properties password properties created_at
user_import importentry properties password properties password
user_import importentry properties password properties updated_at
user_import importentry properties updated_at
user_import importentry properties user_id
user_import importentry properties username
user_import importentry properties webauthn_credentials
user_import importentry properties webauthn_credentials items
user_import importentry properties webauthn_credentials items properties aaguid
user_import importentry properties webauthn_credentials items properties aaguid items
user_import importentry properties webauthn_credentials items properties attestation_type
user_import importentry properties webauthn_credentials items properties backup_eligible
user_import importentry properties webauthn_credentials items properties backup_state
user_import importentry properties webauthn_credentials items properties created_at
user_import importentry properties webauthn_credentials items properties id
user_import importentry properties webauthn_credentials items properties last_used_at
user_import importentry properties webauthn_credentials items properties mfa_only
user_import importentry properties webauthn_credentials items properties name
user_import importentry properties webauthn_credentials items properties public_key
user_import importentry properties webauthn_credentials items properties sign_count
user_import importentry properties webauthn_credentials items properties transports
user_import importentry properties webauthn_credentials items properties transports items
user_import importentry properties webauthn_credentials items properties updated_at
user_import importentry properties webauthn_credentials items properties user_handle
Using configuration file
Using environment variables

Home
Backend configuration
User import
- Reference

Clone this wiki locally

Footer

© 2025 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Docs
Contact

You can’t perform that action at this time.