Ruta de configuración de Tenant

Recupere la configuración del inquilino. También puede especificarse una lista de campos para incluir o excluir.

GET https://{tenantDomain}/api/v2/tenants/settings

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    tenants "github.com/auth0/go-auth0/management/management/tenants"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &tenants.GetTenantSettingsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Tenants.Settings.Get(
        context.TODO(),
        request,
    )
}

200

{
  "acr_values_supported": [
    "<string>"
  ],
  "allow_organization_name_in_authentication_api": false,
  "allowed_logout_urls": [
    "<string>"
  ],
  "authorization_response_iss_parameter_supported": false,
  "change_password": {
    "enabled": false,
    "html": ""
  },
  "client_id_metadata_document_supported": false,
  "country_codes": {
    "list": [
      "<string>"
    ]
  },
  "customize_mfa_in_postlogin_action": false,
  "default_audience": "",
  "default_directory": "",
  "default_redirection_uri": "<string>",
  "default_token_quota": {
    "clients": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    },
    "organizations": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    }
  },
  "device_flow": {
    "charset": "base20",
    "mask": "****-****"
  },
  "enable_ai_guide": true,
  "enabled_locales": [],
  "ephemeral_session_lifetime": 72,
  "error_page": {
    "html": "",
    "show_log_link": false,
    "url": "https://mycompany.org/error"
  },
  "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": false,
    "custom_domains_provisioning": false,
    "dashboard_insights_view": true,
    "dashboard_log_streams_next": true,
    "disable_clickjack_protection_headers": true,
    "disable_fields_map_fix": true,
    "disable_impersonation": false,
    "disable_management_api_sms_obfuscation": true,
    "enable_adfs_waad_email_verification": true,
    "enable_apis_section": false,
    "enable_client_connections": true,
    "enable_dynamic_client_registration": false,
    "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,
    "genai_trial": 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": false
  },
  "friendly_name": "My Company",
  "guardian_mfa_page": {
    "enabled": false,
    "html": ""
  },
  "idle_ephemeral_session_lifetime": 24,
  "idle_session_lifetime": 72,
  "legacy_sandbox_version": "",
  "mtls": {
    "enable_endpoint_aliases": false
  },
  "oidc_logout": {
    "rp_logout_end_session_endpoint_discovery": true
  },
  "phone_consolidated_experience": true,
  "picture_url": "https://mycompany.org/logo.png",
  "pushed_authorization_requests_supported": false,
  "resource_parameter_profile": "audience",
  "sandbox_version": "22",
  "sandbox_versions_available": [
    "<string>"
  ],
  "session_cookie": {
    "mode": "persistent"
  },
  "session_lifetime": 168,
  "sessions": {
    "oidc_logout_prompt_enabled": true
  },
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "support_email": "[e-mail]",
  "support_url": "https://mycompany.org/support"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

fields · string

Lista de campos separados por comas para incluir o excluir (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false).

Respuesta

200

application/json

La configuración del inquilino se recuperó correctamente.

acr_values_supported · string<acr>[] | null

Valores de ACR admitidos

allow_organization_name_in_authentication_api · boolean · predeterminado: false

Si se acepta un nombre de la organización en lugar de un ID en los endpoints de autenticación.

allowed_logout_urls · string<url>[]

URL válidas para redirigir después del Logout de Auth0.

authorization_response_iss_parameter_supported · boolean | null · predeterminado: false

Admite el parámetro iss en las respuestas de autorización

change_password · object

Personalización de la página Change Password.

Show child attributes

client_id_metadata_document_supported · boolean · predeterminado: false · EA

Si el Servidor de autorización admite recuperar metadatos del cliente desde una URL de client_id.

country_codes · object

Configuración del código de país del teléfono para la entrada del identificador.

Show child attributes

customize_mfa_in_postlogin_action · boolean · predeterminado: false

Si se habilitan factores flexibles para MFA en la Action PostLogin.

default_audience · string · predeterminado: ""

Audiencia predeterminada para la autorización de API.

default_directory · string · predeterminado: ""

Nombre de la conexión utilizada para concesiones de contraseña en el endpoint /token. Se admiten los siguientes tipos de conexión: LDAP, AD, conexiones de base de datos, sin contraseña, Windows Azure Active Directory y ADFS.

default_redirection_uri · string

El URI de redirección absoluto predeterminado debe usar https

default_token_quota · object · EA

Configuración de cuota de tokens para configurar las cuotas de emisión de tokens para clientes y organizaciones. Se aplica a todos los clientes y organizaciones, a menos que se anule en la configuración individual del cliente o de la organización.

Show child attributes

device_flow · object

Configuración del flujo de dispositivos

Show child attributes

dynamic_client_registration_security_mode · enum<string> · GA

Establece el valor de third_party_security_mode asignado a los clientes creados mediante Dynamic Client Registration. strict aplica controles de seguridad mejorados. permissive conserva el comportamiento preexistente y solo está disponible para inquilinos con uso previo de clientes de terceros.

Opciones disponibles: strict, permissive

enable_ai_guide · boolean

Si Auth0 Guide (asistencia impulsada por IA) está habilitado para este inquilino.

enabled_locales · enum<string>[]

Configuraciones regionales admitidas para la interfaz de usuario.

Opciones disponibles: am, ar, ar-EG, ar-SA, az, bg, bn, bs, ca-ES, cnr, cs, cy, da, de, el, en, en-CA, es, es-419, es-AR, es-MX, et, eu-ES, fa, fi, fr, fr-CA, fr-FR, gl-ES, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kn, ko, lt, lv, mk, ml, mn, mr, ms, my, nb, nl, nn, no, pa, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, so, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, vi, zgh, zh-CN, zh-HK, zh-MO, zh-TW

ephemeral_session_lifetime · number · predeterminado: 72

Número de horas durante las que una sesión efímera (no persistente) seguirá siendo válida.

Rango requerido: x >= 1

error_page · object

Personalización de la página de error.

Show child attributes

flags · object

Indicadores utilizados para cambiar el comportamiento de este inquilino.

Show child attributes

friendly_name · string · predeterminado: My Company

Nombre descriptivo de este inquilino.

guardian_mfa_page · object

Personalización de la página de Guardian.

Show child attributes

idle_ephemeral_session_lifetime · number · predeterminado: 24

Número de horas durante las que una sesión efímera (no persistente) puede permanecer inactiva antes de que el usuario deba iniciar sesión de nuevo.

Rango requerido: x >= 1

idle_session_lifetime · number · predeterminado: 72

Número de horas durante las que una sesión puede permanecer inactiva antes de que el usuario deba iniciar sesión de nuevo.

legacy_sandbox_version · string · predeterminado: ""

Versión de sandbox seleccionada para la extensibilidad de Rules y Hooks.

mtls · object

Configuración de mTLS.

Show child attributes

oidc_logout · object

Configuración relacionada con Logout iniciado por RP de OIDC

Show child attributes

phone_consolidated_experience · boolean

Si la experiencia consolidada para teléfono está habilitada para este inquilino.

picture_url · string<absolute-uri-or-empty> · predeterminado: https://mycompany.org/logo.png

URL del logotipo que se mostrará para este inquilino (tamaño recomendado: 150x150)

pushed_authorization_requests_supported · boolean · predeterminado: false

Habilita el uso de Pushed Authorization Requests

resource_parameter_profile · enum<string> · predeterminado: audience · GA

Perfil que determina cómo se puede especificar la identidad del recurso protegido (es decir, la API) en los endpoints de OAuth cuando se solicita acceso. Cuando se establece en audience (valor predeterminado), se usa el parámetro audience para especificar el servidor de recursos. Cuando se establece en compatibility, primero se sigue comprobando el parámetro audience, pero si no se proporciona, se puede usar el parámetro resource para especificar el servidor de recursos.

Opciones disponibles: audience, compatibility

sandbox_version · string · predeterminado: 22

Versión de sandbox seleccionada para el entorno de extensibilidad.

sandbox_versions_available · string[]

Versiones de sandbox disponibles para el entorno de extensibilidad.

session_cookie · object

Configuración de la cookie de sesión

Show child attributes

session_lifetime · number · predeterminado: 168

Número de horas durante las que una sesión seguirá siendo válida.

sessions · object

Configuración relacionada con las sesiones del inquilino

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean | null

Controla si se muestra una pantalla de confirmación durante los flujos de Login cuando el Redirect URI usa Callback URI no verificables (por ejemplo, un esquema de URI personalizado como myapp:// o localhost). Si se establece en true, no se mostrará una pantalla de confirmación. Recomendamos establecerlo en false para mejorar la protección contra aplicaciones maliciosas. Consulte https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation para obtener más información.

support_email · string<email-or-empty> · predeterminado: [e-mail]

Dirección de correo electrónico de soporte para el usuario final.

support_url · string<absolute-uri-or-empty> · predeterminado: https://mycompany.org/support

URL de soporte para el usuario final.