docs/interfaces/management.Management.UpdateTenantSettingsRequestContent.html
{}Copy
interface UpdateTenantSettingsRequestContent {
change_password?: TenantSettingsPasswordPage | null;
device_flow?: TenantSettingsDeviceFlow | null;
guardian_mfa_page?: TenantSettingsGuardianPage | null;
default_audience?: string;
default_directory?: string;
error_page?: TenantSettingsErrorPage | null;
default_token_quota?: DefaultTokenQuota | null;
flags?: TenantSettingsFlags;
friendly_name?: string;
picture_url?: string;
support_email?: string;
support_url?: string;
allowed_logout_urls?: string[];
session_lifetime?: number;
session_lifetime_in_minutes?: number;
idle_session_lifetime?: number;
idle_session_lifetime_in_minutes?: number;
ephemeral_session_lifetime?: number;
idle_ephemeral_session_lifetime?: number;
ephemeral_session_lifetime_in_minutes?: number;
idle_ephemeral_session_lifetime_in_minutes?: number;
sandbox_version?: string;
legacy_sandbox_version?: string;
default_redirection_uri?: string;
enabled_locales?: Management.TenantSettingsSupportedLocalesEnum[];
security_headers?: TenantSettingsNullableSecurityHeaders | null;
session_cookie?: SessionCookieSchema | null;
sessions?: TenantSettingsSessions | null;
oidc_logout?: TenantOidcLogoutSettings;
customize_mfa_in_postlogin_action?: boolean | null;
allow_organization_name_in_authentication_api?: boolean | null;
acr_values_supported?: string[] | null;
mtls?: TenantSettingsMtls | null;
pushed_authorization_requests_supported?: boolean | null;
authorization_response_iss_parameter_supported?: boolean | null;
skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile;
client_id_metadata_document_supported?: boolean;
enable_ai_guide?: boolean;
phone_consolidated_experience?: boolean;
include_session_metadata_in_tenant_logs?: boolean;
dynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode;
country_codes?: TenantSettingsCountryCodes | null;
}
change_password?device_flow?guardian_mfa_page?default_audience?default_directory?error_page?default_token_quota?flags?friendly_name?picture_url?support_email?support_url?allowed_logout_urls?session_lifetime?session_lifetime_in_minutes?idle_session_lifetime?idle_session_lifetime_in_minutes?ephemeral_session_lifetime?idle_ephemeral_session_lifetime?ephemeral_session_lifetime_in_minutes?idle_ephemeral_session_lifetime_in_minutes?sandbox_version?legacy_sandbox_version?default_redirection_uri?enabled_locales?security_headers?session_cookie?sessions?oidc_logout?customize_mfa_in_postlogin_action?allow_organization_name_in_authentication_api?acr_values_supported?mtls?pushed_authorization_requests_supported?authorization_response_iss_parameter_supported?skip_non_verifiable_callback_uri_confirmation_prompt?resource_parameter_profile?client_id_metadata_document_supported?enable_ai_guide?phone_consolidated_experience?include_session_metadata_in_tenant_logs?dynamic_client_registration_security_mode?country_codes?
Optionalchange_passwordchange_password?: TenantSettingsPasswordPage | null
Optionaldevice_flowdevice_flow?: TenantSettingsDeviceFlow | null
Device Flow configuration.
Optionalguardian_mfa_pageguardian_mfa_page?: TenantSettingsGuardianPage | null
Optionaldefault_audiencedefault_audience?: string
Default audience for API Authorization.
Optionaldefault_directorydefault_directory?: string
Name of connection used for password grants at the /token endpoint. The following connection types are supported: LDAP, AD, Database Connections, Passwordless, Windows Azure Active Directory, ADFS.
Optionalerror_pageerror_page?: TenantSettingsErrorPage | null
Optionaldefault_token_quotadefault_token_quota?: DefaultTokenQuota | null
Optionalflagsflags?: TenantSettingsFlags
Optionalfriendly_namefriendly_name?: string
Friendly name for this tenant.
Optionalpicture_urlpicture_url?: string
URL of logo to be shown for this tenant (recommended size: 150x150)
Optionalsupport_emailsupport_email?: string
End-user support email.
Optionalsupport_urlsupport_url?: string
End-user support url.
Optionalallowed_logout_urlsallowed_logout_urls?: string[]
URLs that are valid to redirect to after logout from Auth0.
Optionalsession_lifetimesession_lifetime?: number
Number of hours a session will stay valid.
Optionalsession_lifetime_in_minutessession_lifetime_in_minutes?: number
Number of minutes a session will stay valid. Cannot be specified together with session_lifetime.
Optionalidle_session_lifetimeidle_session_lifetime?: number
Number of hours for which a session can be inactive before the user must log in again.
Optionalidle_session_lifetime_in_minutesidle_session_lifetime_in_minutes?: number
Number of minutes a session can be inactive before the user must log in again. Cannot be specified together with idle_session_lifetime.
Optionalephemeral_session_lifetimeephemeral_session_lifetime?: number
Number of hours an ephemeral (non-persistent) session will stay valid.
Optionalidle_ephemeral_session_lifetimeidle_ephemeral_session_lifetime?: number
Number of hours for which an ephemeral (non-persistent) session can be inactive before the user must log in again.
Optionalephemeral_session_lifetime_in_minutesephemeral_session_lifetime_in_minutes?: number
Number of minutes an ephemeral (non-persistent) session will stay valid. Cannot be specified together with ephemeral_session_lifetime.
Optionalidle_ephemeral_session_lifetime_in_minutesidle_ephemeral_session_lifetime_in_minutes?: number
Number of minutes an ephemeral (non-persistent) session can be inactive before the user must log in again. Cannot be specified together with idle_ephemeral_session_lifetime.
Optionalsandbox_versionsandbox_version?: string
Selected sandbox version for the extensibility environment
Optionallegacy_sandbox_versionlegacy_sandbox_version?: string
Selected legacy sandbox version for the extensibility environment
Optionaldefault_redirection_uridefault_redirection_uri?: string
The default absolute redirection uri, must be https
Optionalenabled_localesenabled_locales?: Management.TenantSettingsSupportedLocalesEnum[]
Supported locales for the user interface
Optionalsecurity_headerssecurity_headers?: TenantSettingsNullableSecurityHeaders | null
Optionalsession_cookiesession_cookie?: SessionCookieSchema | null
Optionalsessionssessions?: TenantSettingsSessions | null
Optionaloidc_logoutoidc_logout?: TenantOidcLogoutSettings
Optionalcustomize_mfa_in_postlogin_actioncustomize_mfa_in_postlogin_action?: boolean | null
Whether to enable flexible factors for MFA in the PostLogin action
Optionalallow_organization_name_in_authentication_apiallow_organization_name_in_authentication_api?: boolean | null
Whether to accept an organization name instead of an ID on auth endpoints
Optionalacr_values_supportedacr_values_supported?: string[] | null
Supported ACR values
Optionalmtlsmtls?: TenantSettingsMtls | null
Optionalpushed_authorization_requests_supportedpushed_authorization_requests_supported?: boolean | null
Enables the use of Pushed Authorization Requests
Optionalauthorization_response_iss_parameter_supportedauthorization_response_iss_parameter_supported?: boolean | null
Supports iss parameter in authorization responses
Optionalskip_non_verifiable_callback_uri_confirmation_promptskip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null
Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as myapp://, or localhost). If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
Optionalresource_parameter_profileresource_parameter_profile?: Management.TenantSettingsResourceParameterProfile
Optionalclient_id_metadata_document_supportedclient_id_metadata_document_supported?: boolean
Whether the authorization server supports retrieving client metadata from a client_id URL.
Optionalenable_ai_guideenable_ai_guide?: boolean
Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant.
Optionalphone_consolidated_experiencephone_consolidated_experience?: boolean
Whether Phone Consolidated Experience is enabled for this tenant.
Optionalinclude_session_metadata_in_tenant_logsinclude_session_metadata_in_tenant_logs?: boolean
Whether session metadata is included in specific tenant logs (slo, oidc_backchannel_logout_failed, oidc_backchannel_logout_succeeded).
Optionaldynamic_client_registration_security_modedynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode
Optionalcountry_codescountry_codes?: TenantSettingsCountryCodes | null
Member Visibility
ThemeOSLightDark
Properties change_passworddevice_flowguardian_mfa_pagedefault_audiencedefault_directoryerror_pagedefault_token_quotaflagsfriendly_namepicture_urlsupport_emailsupport_urlallowed_logout_urlssession_lifetimesession_lifetime_in_minutesidle_session_lifetimeidle_session_lifetime_in_minutesephemeral_session_lifetimeidle_ephemeral_session_lifetimeephemeral_session_lifetime_in_minutesidle_ephemeral_session_lifetime_in_minutessandbox_versionlegacy_sandbox_versiondefault_redirection_urienabled_localessecurity_headerssession_cookiesessionsoidc_logoutcustomize_mfa_in_postlogin_actionallow_organization_name_in_authentication_apiacr_values_supportedmtlspushed_authorization_requests_supportedauthorization_response_iss_parameter_supportedskip_non_verifiable_callback_uri_confirmation_promptresource_parameter_profileclient_id_metadata_document_supportedenable_ai_guidephone_consolidated_experienceinclude_session_metadata_in_tenant_logsdynamic_client_registration_security_modecountry_codes