Pre 1.30 System APIs

Whether or not FusionAuth should delete the Audit Log based upon this configuration. When true the auditLogConfiguration.delete.numberOfDaysToRetain will be used to identify audit logs that are eligible for deletion. When this value is set to false audit logs will be preserved forever.

The number of days to retain the Audit Log.

The Access-Control-Allow-Credentials response header values as described by MDN Access-Control-Allow-Credentials.

The Access-Control-Allow-Headers response header values as described by MDN Access-Control-Allow-Headers.

The Access-Control-Allow-Methods response header values as described by MDN Access-Control-Allow-Methods. The possible values are:

• GET
• POST
• PUT
• DELETE
• HEAD
• OPTIONS

The Access-Control-Allow-Origin response header values as described by MDN Access-Control-Allow-Origin. If the wildcard * is specified, no additional domains may be specified.

Whether the FusionAuth CORS filter will process requests made to FusionAuth.

The Access-Control-Expose-Headers response header values as described by MDN Access-Control-Expose-Headers.

The Access-Control-Max-Age response header values as described by MDN Access-Control-Max-Age.

An object that can hold any information about the System that should be persisted.

Whether or not FusionAuth will log debug messages to the event log. This is primarily useful for identifying why the FusionAuth CORS filter is rejecting a request and returning an HTTP response status code of 403.

Indicates that the SMTP email configuration is available for use by FusionAuth.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The host name of the SMTP server that FusionAuth will use.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user is sent a forgot password email.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional password FusionAuth will use to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The port of the SMTP server that FusionAuth will use.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The type of security protocol FusionAuth will use when connecting to the SMTP server. The possible values are:

• NONE - no security will be used. All communications will be sent plaintext.
• SSL - SSL will be used to connect to the SMTP server. This protocol is not recommended unless it is the only one your SMTP server supports.
• TLS - TLS will be used to connect to the SMTP server. This is the preferred protocol for all SMTP servers.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user had their account created for them and they must set their password manually and they are sent an email to set their password.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional username FusionAuth will to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used to send the verification emails to users. These emails are used to verify that a user’s email address is valid. If the verifyEmail field is true this field is required.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the register with your application.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the user changes them.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

A mapping of the configuration for each event type that FusionAuth sends. The event types that are the keys into this Object are:

• user.action - When a user action is triggered
• user.bulk.create - When multiple users are created in bulk (i.e. during an import)
• user.create - When a user is created
• user.email.verified - When a user verifies their email address Available since 1.8.0
• user.update - When a user is updated
• user.deactivate - When a user is deactivated
• user.reactivate - When a user is reactivated
• user.login.success - When a user completes a login request Available since 1.6.0
• user.login.failed - When a user fails a login request Available since 1.6.0
• user.password.breach - When Reactor detects a user is using a potentially breached password (requires an activated license) Available since 1.15.0
• user.registration.create - When a user registration is created Available since 1.6.0
• user.registration.update - When a user registration is updated Available since 1.6.0
• user.registration.delete - When a user registration is deleted Available since 1.6.0
• user.registration.verified - When a user completes registration verification Available since 1.8.0
• user.delete - When a user is deleted
• jwt.public-key.update - When a JWT RSA Public / Private keypair may have been changed
• jwt.refresh - When an access token is refreshed using a refresh token Available since 1.16.0
• jwt.refresh-token.revoke - When a JWT Refresh Token is revoked

In version 1.8.0 and beyond, event configuration is managed per Tenant.

Whether or not FusionAuth should send these types of events to any configured Webhooks.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The transaction type that FusionAuth uses when sending these types of events to any configured Webhooks. The transaction types are:

• None - No Webhooks are required to succeed for the FusionAuth transaction to be committed.
• Any - Only a single Webhook is required to succeed for the FusionAuth transaction to be committed.
• SimpleMajority - A simple majority (50% or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• SuperMajority - A super majority (2/3 or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• AbsoluteMajority - Every Webhook must succeed for the FusionAuth transaction to be committed.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The number of events to retain. Once the number of event logs exceeds this configured value they will be deleted starting with the oldest event logs.

The time in seconds until a OAuth authorization code in no longer valid to be exchanged for an access token. This is essentially the time allowed between the start of an Authorization request during the Authorization code grant and when you request an access token using this authorization code on the Token endpoint.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a change password Id is no longer valid and cannot be used by the Change Password API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a email verification Id is no longer valid and cannot be used by the Verify Email API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a registration verification Id is no longer valid and cannot be used by the Verify Registration API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a setup password Id is no longer valid and cannot be used by the Change Password API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a two factor Id is no longer valid and cannot be used by the Two Factor Login API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until an issued Two Factor trust Id is no longer valid and the User will be required to complete Two Factor authentication during the next authentication attempt.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The duration of the User Action. This value along with the actionDurationUnit will be used to set the duration of the User Action.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The unit of time associated with a duration. The possible values are:

• MINUTES
• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The length of time in seconds before the failed authentication count will be reset.

For example, if tooManyAttempts is set to 5 and you fail to authenticate 4 times in a row, waiting for the duration specified here will cause your fifth attempt to start back at 1.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The number of failed attempts considered to be too many. Once this threshold is reached the specified User Action will be applied to the user for the duration specified.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The Id of the User Action that is applied when the threshold is reached for too many failed authentication attempts.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth OAuth front-end.

In version 1.8.0 and beyond, http session max inactive interval is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name. This is also used as the default issuer value when generating [Keys](/docs/apis/keys).

For example, fusionauth.io.

In version 1.8.0 and beyond, issuer is managed per Tenant.

The Id of the signing key used to sign the access token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The algorithm used to sign the JSON Web Token (JWT). The following available JSON Web Algorithms (JWA) as described in RFC 7518 are available.

• ES256 - ECDSA using P-256 curve and SHA-256 Available since 1.4.0
• ES384 - ECDSA using P-384 curve and SHA-384 Available since 1.4.0
• ES512 - ECDSA using P-521 curve and SHA-512 Available since 1.4.0
• HS256 - HMAC using SHA-256
• HS384 - HMAC using SHA-384
• HS512 - HMAC using SHA-512
• RS256 - RSASSA-PKCS1-v1_5 using SHA-256
• RS384 - RSASSA-PKCS1-v1_5 using SHA-384
• RS512 - RSASSA-PKCS1-v1_5 using SHA-512

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

This value will always be true. The JWT configuration may not be disabled for the System Configuration.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The Id of the signing key used to sign the Id token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name.

For example, fusionauth.io.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The private key used when an RSA signing algorithm has been selected. The private key will be used to sign the JWT. This key will be returned in a PEM encoded format.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The public key used when an RSA signing algorithms has been selected. The public key will be used to verify JWTs signed with the private key. This key will be returned in a PEM encoded format.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in minutes the JWT refresh token will live before it is expired and is not able to be exchanged for a JWT.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The secret used when an HMAC based signing algorithm has been selected. This secret is used to sign and verify JWTs.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in seconds the JWT will live before it is expired. This value is used to calculate the exp (expiration) identity claim.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

Whether or not FusionAuth should delete the login records based upon this configuration. When true the loginRecordConfiguration.delete.numberOfDaysToRetain will be used to identify login records that are eligible for deletion. When this value is set to false login records will be preserved forever.

The number of days to retain login records.

The logout redirect URL when sending the user’s browser to the /oauth2/logout URI of the FusionAuth Front End. This value is only used when a logout URL is not defined in your Application.

In version 1.8.0 and beyond, logoutURL is managed per Tenant.

The password maximum age in days. The number of days after which FusionAuth will require a user to change their password.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the maximum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The password minimum age in seconds. When enabled FusionAuth will not allow a password to be changed until it reaches this minimum age.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the minimum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The selected default encryption scheme.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The factor used by the password encryption scheme. Generally this will be used as an iteration count to generate the hash. The actual use of this value is up to the PasswordEncryptor implementation.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

When enabled a user’s hash configuration will be modified to match these configured settings.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The maximum number of characters that are allowed for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The minimum number of characters that are required for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The number of previous passwords that should be remembered so they are not re-used by the User.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that the remember previous password validation is enabled and being enforced.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require an uppercase and lowercase character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require a non-alphanumeric character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require at least one number to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The time zone used to adjust the stored UTC time when generating reports. Since reports are usually rolled up hourly, this timezone will be used for demarcating the hours.

For example:

America/Denver or US/Mountain

A hexadecimal color to override the default menu color in the user interface.

A FreeMarker template that is rendered when the user requests the /email/complete page. This page is used after a user has verified their email address by clicking the URL in the email. After FusionAuth has updated their user object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/send page. This page is used after a user has asked for the verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/verify page by clicking the URL from the verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

Indicates that the login theme is enabled and will be used to style the login pages.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that contains all of the macros and templates used by the rest of the loginTheme FreeMarker templates (i.e. oauth2Authorize). This allows you to configure the general layout of your UI configuration and login theme without having to copy and paste HTML into each of the templates.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/authorize page. This is the main login page for FusionAuth and is used for all interactive OAuth and OpenId Connect workflows.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/error page. This page is used if the user starts or is in the middle of the OAuth workflow and any type of error occurs. This could be caused by the user messing with the URL or internally some type of information wasn’t passed between the OAuth endpoints correctly. For example, if you are federating login to an external IdP and that IdP does not properly echo the state parameter, FusionAuth’s OAuth workflow will break and this page will be displayed.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor page. This page is used if the user has two-factor authentication enabled and they need to type in their code again. FusionAuth will properly handle the SMS or authenticator app processing on the back end. This page contains the form that the user will put their code into.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/change page. This page is used if the user is required to change their password or if they have requested a password reset. This page contains the form that allows the user to provide a new password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/complete page. This page is used after the user has successfully updated their password (or reset it). This page should instruct the user that their password was updated and that they need to login again.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/forgot page. This page is used when a user starts the forgot password workflow. This page renders the form where the user types in their email address.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/sent page. This page is used when a user has submitted the forgot password form with their email. FusionAuth does not indicate back to the user if their email address was valid in order to prevent malicious activity that could reveal valid email addresses. Therefore, this page should indicate to the user that if their email was valid, they will receive an email shortly with a link to reset their password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/complete page. This page is used after a user has verified their email address for a specific application (i.e. a user registration) by clicking the URL in the email. After FusionAuth has updated their registration object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/send page. This page is used after a user has asked for the application specific verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/verify page by clicking the URL from the application specific verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A CSS stylesheet used to style the login page and other templates such as forgot password, and verify email.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A URL of a logo to override the default FusionAuth logo in the user interface.

A hexadecimal color to override the default menu font color in the user interface.

Whether or not FusionAuth should delete the Audit Log based upon this configuration. When true the auditLogConfiguration.delete.numberOfDaysToRetain will be used to identify audit logs that are eligible for deletion. When this value is set to false audit logs will be preserved forever.

The number of days to retain the Audit Log. Required when auditLogConfiguration.delete.enabled is set to true.

The Access-Control-Allow-Credentials response header values as described by MDN Access-Control-Allow-Credentials.

The Access-Control-Allow-Headers response header values as described by MDN Access-Control-Allow-Headers.

The Access-Control-Allow-Methods response header values as described by MDN Access-Control-Allow-Methods.

The Access-Control-Allow-Origin response header values as described by MDN Access-Control-Allow-Origin. If the wildcard * is specified, no additional domains may be specified.

Whether or not FusionAuth will log debug messages to the event log. This is primarily useful for identifying why the FusionAuth CORS filter is rejecting a request and returning an HTTP response status code of 403.

Whether the FusionAuth CORS filter will process requests made to FusionAuth.

The Access-Control-Expose-Headers response header values as described by MDN Access-Control-Expose-Headers.

The Access-Control-Max-Age response header values as described by MDN Access-Control-Max-Age.

Indicates that the SMTP email configuration is available for use by FusionAuth.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user is sent a forgot password email.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The host name of the SMTP server that FusionAuth will use. Required when systemConfiguration.emailConfiguration.enabled is set to true.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional password FusionAuth will use to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The port of the SMTP server that FusionAuth will use. Required when systemConfiguration.emailConfiguration.enabled is set to true.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user had their account created for them and they must set their password manually and they are sent an email to set their password.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The type of security protocol FusionAuth will use when connecting to the SMTP server. The possible values are:

• NONE - no security will be used. All communications will be sent plaintext.
• SSL - SSL will be used to connect to the SMTP server. This protocol is not recommended unless it is the only one your SMTP server supports.
• TLS - TLS will be used to connect to the SMTP server. This is the preferred protocol for all SMTP servers.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional username FusionAuth will to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The If of the Email Template that is used to send the verification emails to users. These emails are used to verify that a user’s email address is valid. If the verifyEmail field is true this field is required.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the register with your application.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the user changes them.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

A mapping of the configuration for each event type that FusionAuth sends. The event types that are the keys into this Object are:

• user.action - When a user action is triggered
• user.bulk.create - When multiple users are created in bulk (i.e. during an import)
• user.create - When a user is created
• user.email.verified - When a user verifies their email address Available since 1.8.0
• user.update - When a user is updated
• user.deactivate - When a user is deactivated
• user.reactivate - When a user is reactivated
• user.login.success - When a user completes a login request Available since 1.6.0
• user.login.failed - When a user fails a login request Available since 1.6.0
• user.password.breach - When Reactor detects a user is using a potentially breached password (requires an activated license) Available since 1.15.0
• user.registration.create - When a user registration is created Available since 1.6.0
• user.registration.update - When a user registration is updated Available since 1.6.0
• user.registration.delete - When a user registration is deleted Available since 1.6.0
• user.registration.verified - When a user completes registration verification Available since 1.8.0
• user.delete - When a user is deleted
• jwt.public-key.update - When a JWT RSA Public / Private keypair may have been changed
• jwt.refresh - When an access token is refreshed using a refresh token Available since 1.16.0
• jwt.refresh-token.revoke - When a JWT Refresh Token is revoked

In version 1.8.0 and beyond, event configuration is managed per Tenant.

Whether or not FusionAuth should send these types of events to any configured Webhooks.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The transaction type that FusionAuth uses when sending these types of events to any configured Webhooks. The transaction types are:

• None - No Webhooks are required to succeed for the FusionAuth transaction to be committed.
• Any - Only a single Webhook is required to succeed for the FusionAuth transaction to be committed.
• SimpleMajority - A simple majority (50% or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• SuperMajority - A super majority (2/3 or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• AbsoluteMajority - Every Webhook must succeed for the FusionAuth transaction to be committed.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The number of events to retain. Once the number of event logs exceeds this configured value they will be deleted starting with the oldest event logs.

The time in seconds until a OAuth authorization code in no longer valid to be exchanged for an access token. This is essentially the time allowed between the start of an Authorization request during the Authorization code grant and when you request an access token using this authorization code on the Token endpoint.

Value must be greater than 0 and less than or equal to 600.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a change password Id is no longer valid and cannot be used by the Change Password API. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a email verification Id is no longer valid and cannot be used by the Verify Email API. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a registration verification Id is no longer valid and cannot be used by the Verify Registration API. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a setup password Id is no longer valid and cannot be used by the Change Password API. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a two factor Id is no longer valid and cannot be used by the Two Factor Login API. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until an issued Two Factor trust Id is no longer valid and the User will be required to complete Two Factor authentication during the next authentication attempt. Value must be greater than 0.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The duration of the User Action. This value along with the actionDurationUnit will be used to set the duration of the User Action.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The unit of time associated with a duration. The possible values are:

• MINUTES
• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The length of time in seconds before the failed authentication count will be reset.

For example, if tooManyAttempts is set to 5 and you fail to authenticate 4 times in a row, waiting for the duration specified here will cause your fifth attempt to start back at 1.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The number of failed attempts considered to be too many. Once this threshold is reached the specified User Action will be applied to the user for the duration specified.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The Id of the User Action that is applied when the threshold is reached for too many failed authentication attempts.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth Front End.

In version 1.8.0 and beyond, http session max inactive interval is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name. This is also used as the default issuer value when generating [Keys](/docs/apis/keys).

For example, fusionauth.io.

In version 1.8.0 and beyond, issuer is managed per Tenant.

The Id of the signing key used to sign the access token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The algorithm used to sign the JSON Web Token (JWT). The following available JSON Web Algorithms (JWA) as described in RFC 7518 are available.

• ES256 - ECDSA using P-256 curve and SHA-256 Available since 1.4.0
• ES384 - ECDSA using P-384 curve and SHA-384 Available since 1.4.0
• ES512 - ECDSA using P-521 curve and SHA-512 Available since 1.4.0
• HS256 - HMAC using SHA-256
• HS384 - HMAC using SHA-384
• HS512 - HMAC using SHA-512
• RS256 - RSASSA-PKCS1-v1_5 using SHA-256
• RS384 - RSASSA-PKCS1-v1_5 using SHA-384
• RS512 - RSASSA-PKCS1-v1_5 using SHA-512

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The Id of the signing key used to sign the Id token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name.

For example, fusionauth.io.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The private key used when an RSA signing algorithm has been selected. The private key will be used to sign the JWT. This key is expected to be in a PEM encoded format. Required when algorithm is set to an RSA based value.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The public key used when an RSA signing algorithms has been selected. The public key will be used to verify JWTs signed with the private key. This key is expected to be in a PEM encoded format. Required when algorithm is set to an RSA based value.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in minutes the JWT refresh token will live before it is expired and is not able to be exchanged for a JWT.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The secret used when an HMAC based signing algorithm has been selected. This secret is used to sign and verify JWTs. Required when algorithm is set to an HMAC based value.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in seconds the JWT will live before it is expired. This value is used to calculate the exp (expiration) identity claim.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

Whether or not FusionAuth should delete the login records based upon this configuration. When true the loginRecordConfiguration.delete.numberOfDaysToRetain will be used to identify login records that are eligible for deletion. When this value is set to false login records will be preserved forever.

The number of days to retain login records. Required when loginRecordConfiguration.delete.enabled is set to true.

The logout redirect URL when sending the user’s browser to the /oauth2/logout URI of the FusionAuth Front End. This value is only used when a logout URL is not defined in your Application.

In version 1.8.0 and beyond, logoutURL is managed per Tenant.

The password maximum age in days. The number of days after which FusionAuth will require a user to change their password. Required when systemConfiguration.maximumPasswordAge.enabled is set to true.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the maximum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The password minimum age in seconds. When enabled FusionAuth will not allow a password to be changed until it reaches this minimum age. Required when systemConfiguration.minimumPasswordAge.enabled is set to true.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the minimum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The default method for encrypting the User’s password. The following encryptors are provided with FusionAuth:

• salted-md5
• salted-sha256
• salted-hmac-sha256
• salted-pbkdf2-hmac-sha256
• bcrypt

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The factor used by the password encryption scheme. If not provided, the PasswordEncryptor provides a default value. Generally this will be used as an iteration count to generate the hash. The actual use of this value is up to the PasswordEncryptor implementation.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

When enabled a user’s hash configuration will be modified to match these configured settings. This can be useful to increase a password hash strength over time or upgrade imported users to a more secure encryption scheme after an initial import.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The maximum number of characters that are allowed for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The minimum number of characters that are required for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The number of previous passwords that should be remembered so they are not re-used by the User. Required when systemConfiguration.passwordValidationRules.rememberPreviousPasswords.count is set to true.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that the remember previous password validation is enabled and being enforced.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require an uppercase and lowercase character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require a non-alphanumeric character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require at least one number to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The time zone used to adjust the stored UTC time when generating reports. Since reports are usually rolled up hourly, this timezone will be used for demarcating the hours.

For example:

America/Denver or US/Mountain

A hexadecimal color to override the default menu color in the user interface.

Example: 000000 would set the menu color to black.

A FreeMarker template that is rendered when the user requests the /email/complete page. This page is used after a user has verified their email address by clicking the URL in the email. After FusionAuth has updated their user object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/send page. This page is used after a user has asked for the verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/verify page by clicking the URL from the verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

Indicates that the login theme is enabled and will be used to style the login pages.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that contains all of the macros and templates used by the rest of the loginTheme FreeMarker templates (i.e. oauth2Authorize). This allows you to configure the general layout of your UI configuration and login theme without having to copy and paste HTML into each of the templates.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/authorize page. This is the main login page for FusionAuth and is used for all interactive OAuth and OpenId Connect workflows.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/error page. This page is used if the user starts or is in the middle of the OAuth workflow and any type of error occurs. This could be caused by the user messing with the URL or internally some type of information wasn’t passed between the OAuth endpoints correctly. For example, if you are federating login to an external IdP and that IdP does not properly echo the state parameter, FusionAuth’s OAuth workflow will break and this page will be displayed.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor page. This page is used if the user has two-factor authentication enabled and they need to type in their code again. FusionAuth will properly handle the SMS or authenticator app processing on the back end. This page contains the form that the user will put their code into.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/change page. This page is used if the user is required to change their password or if they have requested a password reset. This page contains the form that allows the user to provide a new password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/complete page. This page is used after the user has successfully updated their password (or reset it). This page should instruct the user that their password was updated and that they need to login again.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/forgot page. This page is used when a user starts the forgot password workflow. This page renders the form where the user types in their email address.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/sent page. This page is used when a user has submitted the forgot password form with their email. FusionAuth does not indicate back to the user if their email address was valid in order to prevent malicious activity that could reveal valid email addresses. Therefore, this page should indicate to the user that if their email was valid, they will receive an email shortly with a link to reset their password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/complete page. This page is used after a user has verified their email address for a specific application (i.e. a user registration) by clicking the URL in the email. After FusionAuth has updated their registration object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/send page. This page is used after a user has asked for the application specific verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/verify page by clicking the URL from the application specific verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A CSS stylesheet used to style the login page and other templates such as forgot password, and verify email.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A URL of a logo to override the default FusionAuth logo in the user interface.

A hexadecimal color to override the default menu font color in the user interface.

Example: FFFFFF would set the menu font color to white.

Whether or not FusionAuth should delete the Audit Log based upon this configuration. When true the auditLogConfiguration.delete.numberOfDaysToRetain will be used to identify audit logs that are eligible for deletion. When this value is set to false audit logs will be preserved forever.

The number of days to retain the Audit Log.

The Access-Control-Allow-Credentials response header values as described by MDN Access-Control-Allow-Credentials.

The Access-Control-Allow-Headers response header values as described by MDN Access-Control-Allow-Headers.

The Access-Control-Allow-Methods response header values as described by MDN Access-Control-Allow-Methods. The possible values are:

• GET
• POST
• PUT
• DELETE
• HEAD
• OPTIONS

The Access-Control-Allow-Origin response header values as described by MDN Access-Control-Allow-Origin. If the wildcard * is specified, no additional domains may be specified.

Whether the FusionAuth CORS filter will process requests made to FusionAuth.

The Access-Control-Expose-Headers response header values as described by MDN Access-Control-Expose-Headers.

The Access-Control-Max-Age response header values as described by MDN Access-Control-Max-Age.

An object that can hold any information about the System that should be persisted.

Whether or not FusionAuth will log debug messages to the event log. This is primarily useful for identifying why the FusionAuth CORS filter is rejecting a request and returning an HTTP response status code of 403.

Indicates that the SMTP email configuration is available for use by FusionAuth.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The host name of the SMTP server that FusionAuth will use.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user is sent a forgot password email.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional password FusionAuth will use to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The port of the SMTP server that FusionAuth will use.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The type of security protocol FusionAuth will use when connecting to the SMTP server. The possible values are:

• NONE - no security will be used. All communications will be sent plaintext.
• SSL - SSL will be used to connect to the SMTP server. This protocol is not recommended unless it is the only one your SMTP server supports.
• TLS - TLS will be used to connect to the SMTP server. This is the preferred protocol for all SMTP servers.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used when a user had their account created for them and they must set their password manually and they are sent an email to set their password.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

An optional username FusionAuth will to authenticate with the SMTP server.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

The Id of the Email Template that is used to send the verification emails to users. These emails are used to verify that a user’s email address is valid. If the verifyEmail field is true this field is required.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the register with your application.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

Whether or not user’s email addresses are verified when the user changes them.

In version 1.8.0 and beyond, email configuration is managed per Tenant.

A mapping of the configuration for each event type that FusionAuth sends. The event types that are the keys into this Object are:

• user.action - When a user action is triggered
• user.bulk.create - When multiple users are created in bulk (i.e. during an import)
• user.create - When a user is created
• user.email.verified - When a user verifies their email address Available since 1.8.0
• user.update - When a user is updated
• user.deactivate - When a user is deactivated
• user.reactivate - When a user is reactivated
• user.login.success - When a user completes a login request Available since 1.6.0
• user.login.failed - When a user fails a login request Available since 1.6.0
• user.password.breach - When Reactor detects a user is using a potentially breached password (requires an activated license) Available since 1.15.0
• user.registration.create - When a user registration is created Available since 1.6.0
• user.registration.update - When a user registration is updated Available since 1.6.0
• user.registration.delete - When a user registration is deleted Available since 1.6.0
• user.registration.verified - When a user completes registration verification Available since 1.8.0
• user.delete - When a user is deleted
• jwt.public-key.update - When a JWT RSA Public / Private keypair may have been changed
• jwt.refresh - When an access token is refreshed using a refresh token Available since 1.16.0
• jwt.refresh-token.revoke - When a JWT Refresh Token is revoked

In version 1.8.0 and beyond, event configuration is managed per Tenant.

Whether or not FusionAuth should send these types of events to any configured Webhooks.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The transaction type that FusionAuth uses when sending these types of events to any configured Webhooks. The transaction types are:

• None - No Webhooks are required to succeed for the FusionAuth transaction to be committed.
• Any - Only a single Webhook is required to succeed for the FusionAuth transaction to be committed.
• SimpleMajority - A simple majority (50% or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• SuperMajority - A super majority (2/3 or more) of Webhooks are required to succeed for the FusionAuth transaction to be committed.
• AbsoluteMajority - Every Webhook must succeed for the FusionAuth transaction to be committed.

In version 1.8.0 and beyond, event configuration is managed per Tenant.

The number of events to retain. Once the number of event logs exceeds this configured value they will be deleted starting with the oldest event logs.

The time in seconds until a OAuth authorization code in no longer valid to be exchanged for an access token. This is essentially the time allowed between the start of an Authorization request during the Authorization code grant and when you request an access token using this authorization code on the Token endpoint.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a change password Id is no longer valid and cannot be used by the Change Password API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a email verification Id is no longer valid and cannot be used by the Verify Email API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a registration verification Id is no longer valid and cannot be used by the Verify Registration API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a setup password Id is no longer valid and cannot be used by the Change Password API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until a two factor Id is no longer valid and cannot be used by the Two Factor Login API.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The time in seconds until an issued Two Factor trust Id is no longer valid and the User will be required to complete Two Factor authentication during the next authentication attempt.

In version 1.8.0 and beyond, external identifier configuration is managed per Tenant.

The duration of the User Action. This value along with the actionDurationUnit will be used to set the duration of the User Action.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The unit of time associated with a duration. The possible values are:

• MINUTES
• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The length of time in seconds before the failed authentication count will be reset.

For example, if tooManyAttempts is set to 5 and you fail to authenticate 4 times in a row, waiting for the duration specified here will cause your fifth attempt to start back at 1.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The number of failed attempts considered to be too many. Once this threshold is reached the specified User Action will be applied to the user for the duration specified.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The Id of the User Action that is applied when the threshold is reached for too many failed authentication attempts.

In version 1.8.0 and beyond, failed authentication configuration is managed per Tenant.

The time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth OAuth front-end.

In version 1.8.0 and beyond, http session max inactive interval is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name. This is also used as the default issuer value when generating [Keys](/docs/apis/keys).

For example, fusionauth.io.

In version 1.8.0 and beyond, issuer is managed per Tenant.

The Id of the signing key used to sign the access token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The algorithm used to sign the JSON Web Token (JWT). The following available JSON Web Algorithms (JWA) as described in RFC 7518 are available.

• ES256 - ECDSA using P-256 curve and SHA-256 Available since 1.4.0
• ES384 - ECDSA using P-384 curve and SHA-384 Available since 1.4.0
• ES512 - ECDSA using P-521 curve and SHA-512 Available since 1.4.0
• HS256 - HMAC using SHA-256
• HS384 - HMAC using SHA-384
• HS512 - HMAC using SHA-512
• RS256 - RSASSA-PKCS1-v1_5 using SHA-256
• RS384 - RSASSA-PKCS1-v1_5 using SHA-384
• RS512 - RSASSA-PKCS1-v1_5 using SHA-512

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

This value will always be true. The JWT configuration may not be disabled for the System Configuration.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The Id of the signing key used to sign the Id token.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The name or issuer of the JWT, this is generally something unique such as a fully qualified domain name.

For example, fusionauth.io.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The private key used when an RSA signing algorithm has been selected. The private key will be used to sign the JWT. This key will be returned in a PEM encoded format.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The public key used when an RSA signing algorithms has been selected. The public key will be used to verify JWTs signed with the private key. This key will be returned in a PEM encoded format.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in minutes the JWT refresh token will live before it is expired and is not able to be exchanged for a JWT.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

The secret used when an HMAC based signing algorithm has been selected. This secret is used to sign and verify JWTs.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant and Keymaster.

The length of time in seconds the JWT will live before it is expired. This value is used to calculate the exp (expiration) identity claim.

In version 1.8.0 and beyond, JWT configuration is managed per Tenant.

Whether or not FusionAuth should delete the login records based upon this configuration. When true the loginRecordConfiguration.delete.numberOfDaysToRetain will be used to identify login records that are eligible for deletion. When this value is set to false login records will be preserved forever.

The number of days to retain login records.

The logout redirect URL when sending the user’s browser to the /oauth2/logout URI of the FusionAuth Front End. This value is only used when a logout URL is not defined in your Application.

In version 1.8.0 and beyond, logoutURL is managed per Tenant.

The password maximum age in days. The number of days after which FusionAuth will require a user to change their password.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the maximum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The password minimum age in seconds. When enabled FusionAuth will not allow a password to be changed until it reaches this minimum age.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

Indicates that the minimum password age is enabled and being enforced.

In version 1.8.0 and beyond, password age settings are managed per Tenant.

The selected default encryption scheme.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The factor used by the password encryption scheme. Generally this will be used as an iteration count to generate the hash. The actual use of this value is up to the PasswordEncryptor implementation.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

When enabled a user’s hash configuration will be modified to match these configured settings.

In version 1.8.0 and beyond, password encryption configuration is managed per Tenant.

The maximum number of characters that are allowed for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The minimum number of characters that are required for user passwords.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The number of previous passwords that should be remembered so they are not re-used by the User.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that the remember previous password validation is enabled and being enforced.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require an uppercase and lowercase character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require a non-alphanumeric character to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

Indicates that passwords require at least one number to be valid.

In version 1.8.0 and beyond, password validation rules are configured per Tenant.

The time zone used to adjust the stored UTC time when generating reports. Since reports are usually rolled up hourly, this timezone will be used for demarcating the hours.

For example:

America/Denver or US/Mountain

A hexadecimal color to override the default menu color in the user interface.

A FreeMarker template that is rendered when the user requests the /email/complete page. This page is used after a user has verified their email address by clicking the URL in the email. After FusionAuth has updated their user object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/send page. This page is used after a user has asked for the verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /email/verify page by clicking the URL from the verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

Indicates that the login theme is enabled and will be used to style the login pages.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that contains all of the macros and templates used by the rest of the loginTheme FreeMarker templates (i.e. oauth2Authorize). This allows you to configure the general layout of your UI configuration and login theme without having to copy and paste HTML into each of the templates.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/authorize page. This is the main login page for FusionAuth and is used for all interactive OAuth and OpenId Connect workflows.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/error page. This page is used if the user starts or is in the middle of the OAuth workflow and any type of error occurs. This could be caused by the user messing with the URL or internally some type of information wasn’t passed between the OAuth endpoints correctly. For example, if you are federating login to an external IdP and that IdP does not properly echo the state parameter, FusionAuth’s OAuth workflow will break and this page will be displayed.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor page. This page is used if the user has two-factor authentication enabled and they need to type in their code again. FusionAuth will properly handle the SMS or authenticator app processing on the back end. This page contains the form that the user will put their code into.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/change page. This page is used if the user is required to change their password or if they have requested a password reset. This page contains the form that allows the user to provide a new password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/complete page. This page is used after the user has successfully updated their password (or reset it). This page should instruct the user that their password was updated and that they need to login again.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/forgot page. This page is used when a user starts the forgot password workflow. This page renders the form where the user types in their email address.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /password/sent page. This page is used when a user has submitted the forgot password form with their email. FusionAuth does not indicate back to the user if their email address was valid in order to prevent malicious activity that could reveal valid email addresses. Therefore, this page should indicate to the user that if their email was valid, they will receive an email shortly with a link to reset their password.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/complete page. This page is used after a user has verified their email address for a specific application (i.e. a user registration) by clicking the URL in the email. After FusionAuth has updated their registration object to indicate that their email was verified, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/send page. This page is used after a user has asked for the application specific verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A FreeMarker template that is rendered when the user requests the /registration/verify page by clicking the URL from the application specific verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A CSS stylesheet used to style the login page and other templates such as forgot password, and verify email.

In version 1.8.0 and beyond, theme configuration is managed per Tenant and themes are configured using the Theme API or via the UI.

A URL of a logo to override the default FusionAuth logo in the user interface.

A hexadecimal color to override the default menu font color in the user interface.

The format string used to format the date and time columns in the export result.

When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

The number of bytes to retrieve from the end of each of the system logs. When this value is -1, the entire log will be downloaded.

The time zone used to calculate the current time and build the filename.

For example:

America/Denver or US/Mountain

When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

The format string used to format the date and time columns in the export result.

When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

The number of bytes to retrieve from the end of each of the system logs. When this value is -1, the entire log will be downloaded.

The time zone used to adjust the stored UTC time in the export result.

For example:

America/Denver or US/Mountain

When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

The logger name for which you are requesting to retrieve the current logging level.

The name of the logger.

The current logging level. Possible values are:

• error
• warn
• info
• debug
• trace
• off

The request body is expected to be sent using form encoded data. Ensure your HTTP client sends the Content-Type request header set to application/x-www-form-urlencoded.

The logger name for which you are requesting to update the current logging level.

The requested logging level. Possible values are:

• error
• warn
• info
• debug
• trace
• off

The logging level. If the request was successful, this value should be equal to the request value. Possible values are:

• error
• warn
• info
• debug
• trace
• off

The name of the index to rebuild. The possible values are:

• fusionauth_entity The entity search index
• fusionauth_user The user search index

Please note, that while the index names can be modified using the FusionAuth configuration, that does not change how you call this API. For example, even if you modify the configuration to name the user search index fusionauth_user_dev, you will still use fusionauth_user to indicate you wish to rebuild the user search index.

The version of the running FusionAuth instance.