New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

ProjectConfiguration

The project configuration for Ory Elements.

This configuration is used to set various URLs and settings for the Ory Elements project.

Properties​

default_redirect_url​

default_redirect_url: string

The default redirect URI as configured in the Ory Kratos configuration

error_ui_url​

error_ui_url: string

The URL for the error UI.

hide_ory_branding?​

optional hide_ory_branding: boolean;

Whether to hide the Ory branding badge on the account experience card.

Defaults to false. Customers on qualifying plans can opt into hiding it.

optional hide_registration_link: boolean;

When true, hides the "Sign up" link on the login card footer even if registration is enabled. Cosmetic only; does not affect the registration flow itself. Defaults to false.

login_ui_url​

login_ui_url: string

The URL for the login UI.

logo_dark_url?​

optional logo_dark_url: string;

The URL for the dark logo.

Currently unused.

logo_light_url?​

optional logo_light_url: string;

The URL for the light logo on the auth card.

name​

name: string

The name of the project displayed on the auth card.

recovery_enabled​

recovery_enabled: boolean

Whether recovery is enabled.

Used to determine if the "Forgot Password" link is shown on the password input elements.

recovery_ui_url​

recovery_ui_url: string

The URL for the recovery UI.

registration_enabled​

registration_enabled: boolean

Whether registration is enabled.

Used to determine if the "Sign Up" link is shown on the login card.

registration_ui_url​

registration_ui_url: string

The URL for the registration UI.

settings_ui_url​

settings_ui_url: string

The URL for the settings UI.

verification_enabled​

verification_enabled: boolean

Whether verification is enabled.

Currently unused.

verification_ui_url​

verification_ui_url: string

The URL for the verification UI.

Currently unused.