Auth0 API | Tenants › Settings › Get Tenant Settings

Tenants

tenants

Tenants

Settings

tenants.settings

Methods

Get Tenant Settings ->

TenantSettings

get/tenants/settings

Retrieve tenant settings. A list of fields to include or exclude may also be specified.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

fields: string

Optional

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields: boolean

Optional

Whether specified fields are to be included (true) or excluded (false).

Response fields

TenantSettings

Request example

curl https://login0.local.dev.auth0.com/api/v2/tenants/settings \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

{
  "acr_values_supported": [
    "string"
  ],
  "allow_organization_name_in_authentication_api": true,
  "allowed_logout_urls": [
    "https://example.com"
  ],
  "authorization_response_iss_parameter_supported": true,
  "change_password": {
    "enabled": true,
    "html": "html"
  },
  "customize_mfa_in_postlogin_action": true,
  "default_audience": "default_audience",
  "default_directory": "default_directory",
  "default_redirection_uri": "default_redirection_uri",
  "device_flow": {
    "charset": "base20",
    "mask": "mask"
  },
  "enabled_locales": [
    "am"
  ],
  "error_page": {
    "html": "html",
    "show_log_link": true,
    "url": "https://example.com"
  },
  "flags": {
    "allow_changing_enable_sso": true,
    "allow_legacy_delegation_grant_types": true,
    "allow_legacy_ro_grant_types": true,
    "allow_legacy_tokeninfo_endpoint": true,
    "change_pwd_flow_v1": true,
    "custom_domains_provisioning": true,
    "dashboard_insights_view": true,
    "dashboard_log_streams_next": true,
    "disable_clickjack_protection_headers": true,
    "disable_fields_map_fix": true,
    "disable_impersonation": true,
    "disable_management_api_sms_obfuscation": true,
    "enable_adfs_waad_email_verification": true,
    "enable_apis_section": true,
    "enable_client_connections": true,
    "enable_dynamic_client_registration": true,
    "enable_idtoken_api2": true,
    "enable_legacy_profile": true,
    "enable_pipeline2": true,
    "enable_public_signup_user_exists_error": true,
    "enable_sso": true,
    "enforce_client_authentication_on_passwordless_start": true,
    "improved_signup_bot_detection_in_classic": true,
    "mfa_show_factor_list_on_enrollment": true,
    "no_disclose_enterprise_connections": true,
    "remove_alg_from_jwks": true,
    "revoke_refresh_token_grant": true,
    "trust_azure_adfs_email_verified_connection_property": true
  },
  "friendly_name": "friendly_name",
  "guardian_mfa_page": {
    "enabled": true,
    "html": "html"
  },
  "idle_session_lifetime": 0,
  "legacy_sandbox_version": "legacy_sandbox_version",
  "mtls": {
    "enable_endpoint_aliases": true
  },
  "oidc_logout": {
    "rp_logout_end_session_endpoint_discovery": true
  },
  "picture_url": "https://example.com",
  "pushed_authorization_requests_supported": true,
  "sandbox_version": "sandbox_version",
  "sandbox_versions_available": [
    "string"
  ],
  "session_cookie": {
    "mode": "persistent"
  },
  "session_lifetime": 0,
  "sessions": {
    "oidc_logout_prompt_enabled": true
  },
  "support_email": "support_email",
  "support_url": "https://example.com"
}

Update Tenant Settings ->

TenantSettings

patch/tenants/settings

Update settings for a tenant.

Domain types

TenantSettings = { acr_values_supported, allow_organization_name_in_authentication_api, allowed_logout_urls, 25 more... }