Auth0 Node.js SDK - v7.6.0
    Preparing search index...

    Interface UpdateTenantSettingsRequestContent

    {}
    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[];
        access_token?: ResourceServerAccessToken | null;
        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;
        dpop_strict_refresh_token_binding?: boolean | null;
        skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
        resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile;
        client_id_metadata_document_supported?: boolean;
        client_id_metadata_document_dynamic_registration_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;
    }
    Index
    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? access_token? 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? dpop_strict_refresh_token_binding? skip_non_verifiable_callback_uri_confirmation_prompt? resource_parameter_profile? client_id_metadata_document_supported? client_id_metadata_document_dynamic_registration_supported? enable_ai_guide? phone_consolidated_experience? include_session_metadata_in_tenant_logs? dynamic_client_registration_security_mode? country_codes?
    change_password?: TenantSettingsPasswordPage | null
    device_flow?: TenantSettingsDeviceFlow | null

    Device Flow configuration.

    Optionalguardian_mfa_page

    guardian_mfa_page?: TenantSettingsGuardianPage | null
    default_audience?: string

    Default audience for API Authorization.

    default_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_page

    error_page?: TenantSettingsErrorPage | null
    default_token_quota?: DefaultTokenQuota | null
    flags?: TenantSettingsFlags
    friendly_name?: string

    Friendly name for this tenant.

    picture_url?: string

    URL of logo to be shown for this tenant (recommended size: 150x150)

    support_email?: string

    End-user support email.

    support_url?: string

    End-user support url.

    allowed_logout_urls?: string[]

    URLs that are valid to redirect to after logout from Auth0.

    session_lifetime?: number

    Number of hours a session will stay valid.

    session_lifetime_in_minutes?: number

    Number of minutes a session will stay valid. Cannot be specified together with session_lifetime.

    idle_session_lifetime?: number

    Number of hours for which a session can be inactive before the user must log in again.

    idle_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.

    ephemeral_session_lifetime?: number

    Number of hours an ephemeral (non-persistent) session will stay valid.

    idle_ephemeral_session_lifetime?: number

    Number of hours for which an ephemeral (non-persistent) session can be inactive before the user must log in again.

    ephemeral_session_lifetime_in_minutes?: number

    Number of minutes an ephemeral (non-persistent) session will stay valid. Cannot be specified together with ephemeral_session_lifetime.

    idle_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.

    sandbox_version?: string

    Selected sandbox version for the extensibility environment

    legacy_sandbox_version?: string

    Selected legacy sandbox version for the extensibility environment

    default_redirection_uri?: string

    The default absolute redirection uri, must be https

    enabled_locales?: Management.TenantSettingsSupportedLocalesEnum[]

    Supported locales for the user interface

    access_token?: ResourceServerAccessToken | null
    security_headers?: TenantSettingsNullableSecurityHeaders | null
    session_cookie?: SessionCookieSchema | null
    sessions?: TenantSettingsSessions | null
    oidc_logout?: TenantOidcLogoutSettings
    customize_mfa_in_postlogin_action?: boolean | null

    Whether to enable flexible factors for MFA in the PostLogin action

    allow_organization_name_in_authentication_api?: boolean | null

    Whether to accept an organization name instead of an ID on auth endpoints

    acr_values_supported?: string[] | null

    Supported ACR values

    mtls?: TenantSettingsMtls | null
    pushed_authorization_requests_supported?: boolean | null

    Enables the use of Pushed Authorization Requests

    authorization_response_iss_parameter_supported?: boolean | null

    Supports iss parameter in authorization responses

    dpop_strict_refresh_token_binding?: boolean | null

    Enables strict DPoP refresh token binding per RFC 9449: all refresh tokens issued to public clients that present a DPoP proof are bound to the sender's key, and the binding is validated on every subsequent exchange. When disabled, DPoP refresh token binding may still apply for specific audiences for backwards compatibility.

    skip_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.

    resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile
    client_id_metadata_document_supported?: boolean

    Whether the authorization server supports retrieving client metadata from a client_id URL.

    client_id_metadata_document_dynamic_registration_supported?: boolean

    Whether the authorization server supports registering clients dynamically from a client_id URL. Requires client_id_metadata_document_supported to be enabled.

    enable_ai_guide?: boolean

    Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant.

    phone_consolidated_experience?: boolean

    Whether Phone Consolidated Experience is enabled for this tenant.

    include_session_metadata_in_tenant_logs?: boolean

    Whether session metadata is included in specific tenant logs (slo, oidc_backchannel_logout_failed, oidc_backchannel_logout_succeeded).

    dynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode
    country_codes?: TenantSettingsCountryCodes | null

    Settings
    Member Visibility

    On This Page
    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_localesaccess_tokensecurity_headerssession_cookiesessionsoidc_logoutcustomize_mfa_in_postlogin_actionallow_organization_name_in_authentication_apiacr_values_supportedmtlspushed_authorization_requests_supportedauthorization_response_iss_parameter_supporteddpop_strict_refresh_token_bindingskip_non_verifiable_callback_uri_confirmation_promptresource_parameter_profileclient_id_metadata_document_supportedclient_id_metadata_document_dynamic_registration_supportedenable_ai_guidephone_consolidated_experienceinclude_session_metadata_in_tenant_logsdynamic_client_registration_security_modecountry_codes