> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Actualizar la configuración
> Actualice la configuración de un inquilino.
export const Scopes = ({scopes = []}) => {
return
Scopes
{"Los alcances definen los permisos y los niveles de acceso para las solicitudes a la API y los tokens de autenticación."}
;
};
## OpenAPI
````yaml es/docs/oas/management/v2/management-api-oas.json PATCH /tenants/settings
openapi: 3.1.0
info:
contact:
name: Auth0 Support
url: https://support.auth0.com
description: Auth0 Management API v2.
termsOfService: https://auth0.com/web-terms/
title: Auth0 Management API
version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
variables:
tenantDomain:
default: '{TENANT}.auth0.com'
description: Dominio del Tenant de Auth0
security:
- bearerAuth: []
externalDocs:
description: Documentación de Auth0 Management API
url: https://auth0.com/docs/api/management/v2/
paths:
/tenants/settings:
patch:
tags:
- tenants
summary: Actualizar la configuración del tenant
description: Actualice la configuración de un inquilino.
operationId: patch_settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTenantSettingsRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateTenantSettingsRequestContent'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTenantSettingsResponseContent'
description: La configuración del inquilino se actualizó correctamente.
'400':
description: Cuerpo de la solicitud no válido. El mensaje variará según la causa.
'401':
description: Token no válido.
x-description-1: Client is not global.
x-description-2: Invalid signature received for JSON Web Token validation.
'403':
description: >-
scope insuficiente; se esperaba alguno de los siguientes:
update:tenant_settings.
'429':
description: >-
Demasiadas solicitudes. Revise los encabezados X-RateLimit-Limit,
X-RateLimit-Remaining y X-RateLimit-Reset.
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- update:tenant_settings
x-codeSamples:
- label: Update tenant settings
lang: go
source: |
package example
import (
context "context"
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(
"",
),
)
request := &tenants.UpdateTenantSettingsRequestContent{}
client.Tenants.Settings.Update(
context.TODO(),
request,
)
}
- label: Update tenant settings
lang: typescript
source: |
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
token: "",
});
await client.tenants.settings.update({});
}
main();
- label: Update tenant settings
lang: javascript
source: |
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
token: "",
});
await client.tenants.settings.update({});
}
main();
components:
schemas:
UpdateTenantSettingsRequestContent:
additionalProperties: false
minProperties: 1
properties:
acr_values_supported:
description: Valores de ACR admitidos
items:
format: acr
type: string
minItems: 0
type:
- array
- 'null'
allow_organization_name_in_authentication_api:
default: false
description: >-
Si se debe aceptar un nombre de la organización en lugar de un ID en
los endpoints de autenticación
type:
- boolean
- 'null'
allowed_logout_urls:
description: >-
URL válidas a las que se puede redirigir tras cerrar sesión en
Auth0.
items:
format: url-with-placeholders
type: string
type: array
authorization_response_iss_parameter_supported:
default: false
description: Admite el parámetro iss en las respuestas de autorización
type:
- boolean
- 'null'
change_password:
$ref: '#/components/schemas/TenantSettingsPasswordPage'
client_id_metadata_document_supported:
default: false
description: >-
Si el Servidor de autorización admite recuperar metadatos del
cliente desde una URL de client_id.
type: boolean
x-release-lifecycle: EA
country_codes:
$ref: '#/components/schemas/TenantSettingsCountryCodes'
customize_mfa_in_postlogin_action:
default: false
description: >-
Si se deben habilitar factores flexibles para MFA en la Action
PostLogin
type:
- boolean
- 'null'
default_audience:
default: ''
description: Audiencia predeterminada para la autorización de API.
type: string
default_directory:
default: ''
description: >-
Nombre de la conexión usada para las 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, ADFS.
type: string
default_redirection_uri:
description: El URI de redirección absoluto predeterminado debe usar https
format: absolute-https-uri-or-empty
type: string
default_token_quota:
$ref: '#/components/schemas/DefaultTokenQuota'
x-release-lifecycle: EA
device_flow:
$ref: '#/components/schemas/TenantSettingsDeviceFlow'
description: Configuración del flujo del dispositivo.
dynamic_client_registration_security_mode:
$ref: >-
#/components/schemas/TenantSettingsDynamicClientRegistrationSecurityMode
x-release-lifecycle: GA
enable_ai_guide:
description: >-
Si Auth0 Guide (asistencia basada en IA) está habilitado para este
inquilino.
type: boolean
enabled_locales:
description: Configuraciones regionales admitidas para la interfaz de usuario
items:
$ref: '#/components/schemas/TenantSettingsSupportedLocalesEnum'
minItems: 1
type: array
ephemeral_session_lifetime:
default: 72
description: >-
Número de horas durante las que una sesión efímera (no persistente)
seguirá siendo válida.
minimum: 1
type: integer
ephemeral_session_lifetime_in_minutes:
description: >-
Número de minutos durante los que una sesión efímera (no
persistente) permanecerá válida. No puede especificarse junto con
`ephemeral_session_lifetime`.
minimum: 1
type: integer
error_page:
$ref: '#/components/schemas/TenantSettingsErrorPage'
flags:
$ref: '#/components/schemas/TenantSettingsFlags'
friendly_name:
default: My Company
description: Nombre descriptivo de este inquilino.
type: string
guardian_mfa_page:
$ref: '#/components/schemas/TenantSettingsGuardianPage'
idle_ephemeral_session_lifetime:
default: 24
description: >-
Número de horas que una sesión efímera (no persistente) puede
permanecer inactiva antes de que el usuario deba iniciar sesión de
nuevo.
minimum: 1
type: integer
idle_ephemeral_session_lifetime_in_minutes:
description: >-
Número de minutos que una sesión efímera (no persistente) puede
permanecer inactiva antes de que el usuario deba volver a iniciar
sesión. No puede especificarse junto con
`idle_ephemeral_session_lifetime`.
minimum: 1
type: integer
idle_session_lifetime:
default: 72
description: >-
Número de horas que una sesión puede permanecer inactiva antes de
que el usuario deba iniciar sesión de nuevo.
minimum: 1
type: integer
idle_session_lifetime_in_minutes:
description: >-
Número de minutos que una sesión puede permanecer inactiva antes de
que el usuario deba volver a iniciar sesión. No puede especificarse
junto con `idle_session_lifetime`.
minimum: 1
type: integer
include_session_metadata_in_tenant_logs:
default: false
description: >-
Indica si los metadatos de la sesión se incluyen en registros
específicos del inquilino (slo, oidc_backchannel_logout_failed,
oidc_backchannel_logout_succeeded).
type: boolean
x-release-lifecycle: EA
legacy_sandbox_version:
description: >-
Versión de sandbox legado seleccionada para el entorno de
extensibilidad
maxLength: 8
type: string
mtls:
$ref: '#/components/schemas/TenantSettingsMTLS'
oidc_logout:
$ref: '#/components/schemas/TenantOIDCLogoutSettings'
phone_consolidated_experience:
description: >-
Si Phone Consolidated Experience está habilitado para este
inquilino.
type: boolean
picture_url:
default: https://mycompany.org/logo.png
description: >-
URL del logotipo que se mostrará para este inquilino (tamaño
recomendado: 150x150)
format: absolute-uri-or-empty
type: string
pushed_authorization_requests_supported:
default: false
description: Habilita el uso de Pushed Authorization Requests
type:
- boolean
- 'null'
resource_parameter_profile:
$ref: '#/components/schemas/TenantSettingsResourceParameterProfile'
x-release-lifecycle: GA
sandbox_version:
default: '22'
description: Versión de sandbox seleccionada para el entorno de extensibilidad
maxLength: 8
type: string
security_headers:
$ref: '#/components/schemas/TenantSettingsNullableSecurityHeaders'
session_cookie:
$ref: '#/components/schemas/SessionCookieSchema'
session_lifetime:
default: 168
description: Número de horas durante las que una sesión seguirá siendo válida.
minimum: 1
type: integer
session_lifetime_in_minutes:
description: >-
Número de minutos durante los que una sesión permanecerá válida. No
puede especificarse junto con `session_lifetime`.
minimum: 1
type: integer
sessions:
$ref: '#/components/schemas/TenantSettingsSessions'
skip_non_verifiable_callback_uri_confirmation_prompt:
description: >-
Controla si se muestra una confirmación durante los flujos de inicio
de sesión cuando el URI de redirección usa URI de callback no
verificables (por ejemplo, un esquema de URI personalizado como
`myapp://` o `localhost`).
Si se establece en true, no se mostrará ninguna confirmación.
Recomendamos establecerlo en false para mejorar la protección frente
a aplicaciones maliciosas.
Consulta
https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation
para obtener más información.
type:
- boolean
- 'null'
support_email:
default: support@mycompany.org
description: Correo electrónico de soporte para el usuario final.
format: email-or-empty
type: string
support_url:
default: https://mycompany.org/support
description: URL de soporte para el usuario final.
format: absolute-uri-or-empty
type: string
type: object
UpdateTenantSettingsResponseContent:
additionalProperties: false
properties:
acr_values_supported:
description: Valores ACR admitidos
items:
format: acr
type: string
minItems: 0
type:
- array
- 'null'
allow_organization_name_in_authentication_api:
default: false
description: >-
Si se acepta un nombre de la organización en lugar de un ID en los
endpoints de autenticación
type: boolean
allowed_logout_urls:
description: >-
URL válidas a las que se puede redirigir tras cerrar sesión en
Auth0.
items:
format: url
type: string
type: array
authorization_response_iss_parameter_supported:
default: false
description: Admite el parámetro iss en las respuestas de autorización
type:
- boolean
- 'null'
change_password:
$ref: '#/components/schemas/TenantSettingsPasswordPage'
client_id_metadata_document_supported:
default: false
description: >-
Si el Servidor de autorización admite recuperar metadatos del
cliente desde una URL de client_id.
type: boolean
x-release-lifecycle: EA
country_codes:
$ref: '#/components/schemas/TenantSettingsCountryCodesResponse'
customize_mfa_in_postlogin_action:
default: false
description: Si se habilitan factores flexibles para MFA en la Action PostLogin
type: boolean
default_audience:
default: ''
description: Audiencia predeterminada para la autorización de API.
type: string
default_directory:
default: ''
description: >-
Nombre de la conexión que se usa 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, ADFS.
type: string
default_redirection_uri:
description: La URI de redirección absoluta predeterminada debe usar https
type: string
default_token_quota:
$ref: '#/components/schemas/DefaultTokenQuota'
x-release-lifecycle: EA
device_flow:
$ref: '#/components/schemas/TenantSettingsDeviceFlow'
dynamic_client_registration_security_mode:
$ref: >-
#/components/schemas/TenantSettingsDynamicClientRegistrationSecurityMode
x-release-lifecycle: GA
enable_ai_guide:
description: >-
Si Auth0 Guide (asistencia impulsada por IA) está habilitado para
este inquilino.
type: boolean
enabled_locales:
description: Locales admitidos para la interfaz de usuario.
items:
$ref: '#/components/schemas/SupportedLocales'
type: array
ephemeral_session_lifetime:
default: 72
description: >-
Número de horas durante las que una sesión efímera (no persistente)
seguirá siendo válida.
minimum: 1
type: number
error_page:
$ref: '#/components/schemas/TenantSettingsErrorPage'
flags:
$ref: '#/components/schemas/TenantSettingsFlags'
friendly_name:
default: My Company
description: Nombre descriptivo de este inquilino.
type: string
guardian_mfa_page:
$ref: '#/components/schemas/TenantSettingsGuardianPage'
idle_ephemeral_session_lifetime:
default: 24
description: >-
Número de horas que una sesión efímera (no persistente) puede
permanecer inactiva antes de que el usuario deba iniciar sesión de
nuevo.
minimum: 1
type: number
idle_session_lifetime:
default: 72
description: >-
Número de horas que una sesión puede permanecer inactiva antes de
que el usuario deba iniciar sesión de nuevo.
type: number
include_session_metadata_in_tenant_logs:
default: false
description: >-
Indica si los metadatos de la sesión se incluyen en registros
específicos del inquilino (slo, oidc_backchannel_logout_failed,
oidc_backchannel_logout_succeeded).
type: boolean
x-release-lifecycle: EA
legacy_sandbox_version:
default: ''
description: >-
Versión de sandbox seleccionada para la extensibilidad de Rules y
Hooks.
type: string
mtls:
$ref: '#/components/schemas/TenantSettingsMTLS'
oidc_logout:
$ref: '#/components/schemas/TenantOIDCLogoutSettings'
phone_consolidated_experience:
description: >-
Si Phone Consolidated Experience está habilitado para este
inquilino.
type: boolean
picture_url:
default: https://mycompany.org/logo.png
description: >-
URL del logotipo que se mostrará para este inquilino (tamaño
recomendado: 150x150)
format: absolute-uri-or-empty
type: string
pushed_authorization_requests_supported:
default: false
description: Habilita el uso de Pushed Authorization Requests
type: boolean
resource_parameter_profile:
$ref: '#/components/schemas/TenantSettingsResourceParameterProfile'
x-release-lifecycle: GA
sandbox_version:
default: '22'
description: Versión de sandbox seleccionada para el entorno de extensibilidad.
type: string
sandbox_versions_available:
description: Versiones de sandbox disponibles para el entorno de extensibilidad.
items:
type: string
type: array
security_headers:
$ref: '#/components/schemas/TenantSettingsNullableSecurityHeaders'
session_cookie:
$ref: '#/components/schemas/SessionCookieSchema'
session_lifetime:
default: 168
description: Número de horas durante las que una sesión seguirá siendo válida.
type: number
sessions:
$ref: '#/components/schemas/TenantSettingsSessions'
skip_non_verifiable_callback_uri_confirmation_prompt:
description: >-
Controla si se muestra una pantalla de confirmación durante los
flujos de Login cuando la URI de redirección usa URI de callback no
verificables (por ejemplo, un esquema de URI personalizado como
`myapp://` o `localhost`).
Si se establece en true, no se mostrará ninguna pantalla de
confirmación. Recomendamos establecerlo en false para mejorar la
protección contra aplicaciones maliciosas.
Consulta
https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation
para obtener más información.
type:
- boolean
- 'null'
support_email:
default: support@mycompany.org
description: Dirección de correo electrónico de soporte para el usuario final.
format: email-or-empty
type: string
support_url:
default: https://mycompany.org/support
description: URL de soporte para el usuario final.
format: absolute-uri-or-empty
type: string
type: object
TenantSettingsPasswordPage:
additionalProperties: false
description: Personalización de la página Change Password.
properties:
enabled:
default: false
description: >-
Indica si se debe usar el HTML personalizado de Change Password
(true) o la página predeterminada de Auth0 (false). De forma
predeterminada, se usa la página de Auth0.
type: boolean
html:
default: ''
description: >-
HTML personalizado de Change Password (se admite la sintaxis
Liquid).
type: string
type:
- object
- 'null'
TenantSettingsCountryCodes:
additionalProperties: false
description: >-
Configuración del código de país del teléfono para la entrada del
identificador.
properties:
list:
description: Array de códigos de país ISO 3166-1 alfa-2.
items:
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
type: string
type: array
mode:
$ref: '#/components/schemas/TenantSettingsCountryCodesMode'
type:
- object
- 'null'
DefaultTokenQuota:
additionalProperties: false
description: >-
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.
minProperties: 1
properties:
clients:
$ref: '#/components/schemas/TokenQuotaConfiguration'
organizations:
$ref: '#/components/schemas/TokenQuotaConfiguration'
type:
- object
- 'null'
x-release-lifecycle: EA
TenantSettingsDeviceFlow:
additionalProperties: false
description: Configuración del flujo de dispositivos
properties:
charset:
$ref: '#/components/schemas/TenantSettingsDeviceFlowCharset'
mask:
default: '****-****'
description: >-
Máscara utilizada para dar formato a un código de usuario generado
de manera que sea fácil de leer.
maxLength: 20
type: string
type:
- object
- 'null'
TenantSettingsDynamicClientRegistrationSecurityMode:
description: >-
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.
enum:
- strict
- permissive
type: string
x-release-lifecycle: GA
TenantSettingsSupportedLocalesEnum:
enum:
- 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
type: string
TenantSettingsErrorPage:
additionalProperties: false
description: Personalización de la página de error.
properties:
html:
default: ''
description: >-
HTML de error personalizado (se
admite la sintaxis Liquid).
type: string
show_log_link:
default: false
description: >-
Indica si se debe mostrar el enlace al registro como parte de la
página de error predeterminada (true, valor predeterminado) o si no
debe mostrarse (false).
type: boolean
url:
default: https://mycompany.org/error
description: >-
URL a la que redirigir cuando se produce un error, en lugar de
mostrar la página de error predeterminada.
format: absolute-uri-or-empty
type: string
type:
- object
- 'null'
TenantSettingsFlags:
additionalProperties: false
description: Indicadores utilizados para cambiar el comportamiento de este inquilino.
properties:
allow_changing_enable_sso:
description: >-
Indica si la configuración `enable_sso` puede cambiarse (true) o no
(false).
type: boolean
allow_legacy_delegation_grant_types:
description: >-
Si está habilitado, los clientes pueden agregar concesiones de
delegación heredadas.
type: boolean
allow_legacy_ro_grant_types:
description: >-
Si está habilitado, los clientes pueden agregar concesiones RO
heredadas.
type: boolean
allow_legacy_tokeninfo_endpoint:
description: >-
Indica si el endpoint legado `/tokeninfo` está habilitado para su
cuenta (true) o no está disponible (false).
type: boolean
change_pwd_flow_v1:
default: false
description: >-
Indica si se debe usar el flujo Change Password v1 anterior (true,
no recomendado salvo por compatibilidad con versiones anteriores) o
el flujo más reciente y seguro (false, recomendado).
type: boolean
custom_domains_provisioning:
default: false
description: >-
Si es true, la funcionalidad de dominios personalizados se
habilitará para el inquilino.
type: boolean
dashboard_insights_view:
description: Habilita la nueva vista de la página Activity de Insights
type: boolean
dashboard_log_streams_next:
description: Habilita el acceso beta a los cambios de Log Streaming
type: boolean
disable_clickjack_protection_headers:
description: >-
Indica si las pantallas de Universal Login clásico incluyen
encabezados de seguridad adicionales para evitar el clickjacking
(true) o no incluyen ninguna protección (false).
type: boolean
disable_fields_map_fix:
description: >-
Deshabilita la corrección del mapeo de campos SAML para asignaciones
incorrectas con atributos repetidos
type: boolean
disable_impersonation:
default: false
description: >-
Indica si la funcionalidad de suplantación se ha deshabilitado
(true) o no (false). Solo lectura.
type: boolean
disable_management_api_sms_obfuscation:
default: true
description: >-
Si es true, los números de teléfono para SMS no se ofuscarán en las
llamadas GET a Management API.
type: boolean
enable_adfs_waad_email_verification:
description: >-
Habilita el flujo de verificación de correo electrónico durante el
inicio de sesión para conexiones de Azure AD y ADFS
type: boolean
enable_apis_section:
default: false
description: >-
Indica si la sección APIs está habilitada (true) o deshabilitada
(false).
type: boolean
enable_client_connections:
default: true
description: >-
Indica si deben habilitarse todas las conexiones actuales cuando se
crea un nuevo cliente (aplicación) (true, valor predeterminado) o no
(false).
type: boolean
enable_dynamic_client_registration:
default: false
description: >-
Indica si los desarrolladores de terceros pueden registrar
dinámicamente aplicaciones para sus API (true) o no (false).
Este indicador habilita Dynamic Client Registration.
type: boolean
enable_idtoken_api2:
description: >-
Indica si los ID Token se pueden usar para autorizar algunos tipos
de solicitudes a API v2 (true) o no (false).
type: boolean
enable_legacy_profile:
description: >-
Indica si los ID Token y el endpoint userinfo incluyen un perfil de
usuario completo (true) o solo claims de OpenID Connect (false).
type: boolean
enable_pipeline2:
default: true
description: >-
Indica si los escenarios avanzados de autorización de API están
habilitados (true) o deshabilitados (false).
type: boolean
enable_public_signup_user_exists_error:
description: >-
Indica si el proceso de registro público muestra un error
user_exists (true) o un error genérico (false) si el usuario ya
existe.
type: boolean
enable_sso:
description: >-
Indica si se solicita a los usuarios que confirmen el inicio de
sesión antes de la redirección de SSO (false) o si no se les
solicita (true).
type: boolean
enforce_client_authentication_on_passwordless_start:
description: >-
Exigir autenticación del cliente para el inicio de sesión sin
contraseña.
type: boolean
genai_trial:
description: Este inquilino se registró para la prueba de Auth4GenAI
type: boolean
improved_signup_bot_detection_in_classic:
description: >-
Mejora la detección de bots durante el registro en Universal Login
clásico
type: boolean
mfa_show_factor_list_on_enrollment:
description: >-
Se utiliza para permitir que los usuarios elijan en qué factor
inscribirse entre los factores MFA disponibles.
type: boolean
no_disclose_enterprise_connections:
description: >-
No publicar información de conexiones empresariales con dominios de
IdP en el archivo de configuración de Lock.
type: boolean
remove_alg_from_jwks:
description: Elimina la propiedad alg del endpoint .well-known de jwks
type: boolean
revoke_refresh_token_grant:
description: >-
Elimina la concesión subyacente cuando se revoca un Token de
actualización mediante la Authentication API.
type: boolean
trust_azure_adfs_email_verified_connection_property:
default: false
description: >-
Cambia el comportamiento de email_verified para las conexiones de
Azure AD/ADFS cuando está habilitado. En caso contrario, establece
email_verified en false.
type: boolean
type: object
TenantSettingsGuardianPage:
additionalProperties: false
description: Personalización de la página de Guardian.
properties:
enabled:
default: false
description: >-
Indica si se debe usar el HTML personalizado de Guardian (true) o la
página predeterminada de Auth0 (false, valor predeterminado)
type: boolean
html:
default: ''
description: ' HTML personalizado de Guardian (se admite la sintaxis Liquid).'
type: string
type:
- object
- 'null'
TenantSettingsMTLS:
additionalProperties: false
description: Configuración de mTLS.
properties:
enable_endpoint_aliases:
default: false
description: Si es true, habilita alias de endpoint de mTLS
type: boolean
type:
- object
- 'null'
TenantOIDCLogoutSettings:
additionalProperties: false
description: Configuración relacionada con Logout iniciado por RP de OIDC
properties:
rp_logout_end_session_endpoint_discovery:
default: true
description: >-
Habilita la URL `end_session_endpoint` en la configuración de
detección de .well-known
type: boolean
type: object
TenantSettingsResourceParameterProfile:
default: audience
description: >-
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.
enum:
- audience
- compatibility
type: string
x-release-lifecycle: GA
TenantSettingsNullableSecurityHeaders:
additionalProperties: false
description: >-
Configuración de encabezados de seguridad para las respuestas del
inquilino.
properties:
content_security_policy:
$ref: '#/components/schemas/ContentSecurityPolicyConfig'
x_xss_protection:
$ref: '#/components/schemas/XssProtectionConfig'
type:
- object
- 'null'
SessionCookieSchema:
additionalProperties: false
description: Configuración de la cookie de sesión
properties:
mode:
$ref: '#/components/schemas/SessionCookieModeEnum'
required:
- mode
type:
- object
- 'null'
TenantSettingsSessions:
additionalProperties: false
description: Configuración relacionada con las sesiones del inquilino
properties:
oidc_logout_prompt_enabled:
default: true
description: >-
Indica si se debe omitir la lógica de solicitud (false) al realizar
OIDC Logout
type: boolean
type:
- object
- 'null'
TenantSettingsCountryCodesResponse:
additionalProperties: false
description: >-
Configuración del código de país del teléfono para la entrada del
identificador.
properties:
list:
description: Array de códigos de país ISO 3166-1 alfa-2.
items:
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
type: string
type: array
mode:
$ref: '#/components/schemas/TenantSettingsCountryCodesModeResponse'
type: object
SupportedLocales:
enum:
- 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
type: string
TenantSettingsCountryCodesMode:
description: Indica si la lista es una allowlist o una denylist.
enum:
- allow
- deny
type: string
TokenQuotaConfiguration:
additionalProperties: true
properties:
client_credentials:
$ref: '#/components/schemas/TokenQuotaClientCredentials'
required:
- client_credentials
type: object
TenantSettingsDeviceFlowCharset:
default: base20
description: >-
Conjunto de caracteres utilizado para generar un código de usuario.
Puede ser `base20` o `digits`.
enum:
- base20
- digits
type: string
ContentSecurityPolicyConfig:
additionalProperties: false
description: >-
Configuración de Content Security Policy con compatibilidad con varias
políticas.
properties:
enabled:
description: Indica si CSP está habilitada.
type: boolean
policies:
$ref: '#/components/schemas/CspPolicies'
reporting_infrastructure:
$ref: '#/components/schemas/CspReportingInfrastructure'
type:
- object
- 'null'
XssProtectionConfig:
additionalProperties: false
description: >-
Configuración del encabezado X-XSS-Protection (encabezado obsoleto; use
CSP en su lugar).
properties:
enabled:
description: Indica si el encabezado X-XSS-Protection está habilitado.
type: boolean
mode:
$ref: '#/components/schemas/XssProtectionMode'
report_uri:
description: >-
Endpoint HTTPS para los informes de infracciones de
X-XSS-Protection.
type: string
type:
- object
- 'null'
SessionCookieModeEnum:
default: persistent
description: Comportamiento de la cookie de sesión
enum:
- persistent
- non-persistent
type: string
TenantSettingsCountryCodesModeResponse:
description: Indica si la lista es una allowlist o una denylist.
enum:
- allow
- deny
type: string
TokenQuotaClientCredentials:
additionalProperties: false
description: La configuración de la cuota de tokens
minProperties: 1
properties:
enforce:
description: >-
Si está habilitada, la cuota se aplicará y las solicitudes que la
superen fallarán. Si está deshabilitada, la cuota no se aplicará,
pero las notificaciones sobre las solicitudes que la superen estarán
disponibles en los registros.
type: boolean
per_day:
description: Número máximo de tokens emitidos por día
maximum: 2147483647
minimum: 1
type: integer
per_hour:
description: Número máximo de tokens emitidos por hora
maximum: 2147483647
minimum: 1
type: integer
type: object
CspPolicies:
description: Array de políticas de CSP (de aplicación y/o de informes).
items:
$ref: '#/components/schemas/CspPolicy'
type: array
CspReportingInfrastructure:
additionalProperties: false
description: Configuración global de la infraestructura de informes.
properties:
report_to:
$ref: '#/components/schemas/CspReportTo'
reporting_endpoints:
$ref: '#/components/schemas/CspReportingEndpoints'
type:
- object
- 'null'
XssProtectionMode:
description: 'Modo de X-XSS-Protection: block.'
enum:
- block
type: string
CspPolicy:
additionalProperties: false
description: >-
Una única política de CSP con modo, directivas, indicadores e informes
opcionales.
properties:
directives:
$ref: '#/components/schemas/CspDirectives'
flags:
$ref: '#/components/schemas/CspFlags'
mode:
$ref: '#/components/schemas/CspPolicyMode'
reporting:
$ref: '#/components/schemas/CspPolicyReporting'
type: object
CspReportTo:
additionalProperties: false
description: Configuración del encabezado Report-To.
properties:
endpoints:
$ref: '#/components/schemas/CspReportToEndpoints'
group:
description: Identificador del grupo de informes.
type: string
max_age:
description: Tiempo máximo de vigencia, en segundos, del encabezado Report-To.
type: integer
type:
- object
- 'null'
CspReportingEndpoints:
additionalProperties:
type: string
description: Configuración del encabezado Reporting-Endpoints (pares clave-valor).
type: object
CspDirectives:
additionalProperties:
items:
maxLength: 2048
type: string
type: array
description: >-
Mapa de directivas de CSP. Las claves son nombres de directiva; los
valores son matrices de valores de directiva.
maxProperties: 30
type: object
CspFlags:
description: Indicadores de CSP (directivas sin valores).
items:
$ref: '#/components/schemas/CspFlag'
type: array
CspPolicyMode:
description: 'Modo de la política: de aplicación o de informes.'
enum:
- enforcing
- reporting
type: string
CspPolicyReporting:
additionalProperties: false
description: Configuración de informes por política.
properties:
report_to_group:
description: Nombre del grupo Report-To para informes modernos.
type: string
report_uri:
description: Endpoint HTTPS para informes de infracciones de CSP.
type: string
type:
- object
- 'null'
CspReportToEndpoints:
description: Array de endpoints de informes.
items:
$ref: '#/components/schemas/CspReportToEndpoint'
type: array
CspFlag:
enum:
- upgrade-insecure-requests
- block-all-mixed-content
type: string
CspReportToEndpoint:
additionalProperties: false
description: Un único endpoint de informes.
properties:
url:
description: URL HTTPS del endpoint de informes.
type: string
type: object
securitySchemes:
bearerAuth:
bearerFormat: jwt
scheme: bearer
type: http
oAuth2ClientCredentials:
flows:
clientCredentials:
scopes:
create:actions: Create Actions
create:authentication_methods: Create Authentication Methods
create:client_credentials: Create Client Credentials
create:client_grants: Create Client Grants
create:clients: Create Clients
create:connection_profiles: Create Connection Profiles
create:connections: Create Connections
create:connections_keys: Create Connections Keys
create:current_user_device_credentials: Create Current User Device Credentials
create:custom_domains: Create Custom Domains
create:custom_signing_keys: Create Custom Signing Keys
create:directory_provisionings: Create Directory Provisionings
create:email_provider: Create Email Provider
create:email_templates: Create Email Templates
create:encryption_keys: Create Encryption Keys
create:event_streams: Create Event Streams
create:experimentation: Create Experimentation
create:flows: Create Flows
create:flows_vault_connections: Create Flows Vault Connections
create:forms: Create Forms
create:group_roles: Create Group Roles
create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
create:hooks: Create Hooks
create:log_streams: Create Log Streams
create:network_acls: Create Network Acls
create:organization_client_grants: Create Organization Client Grants
create:organization_connections: Create Organization Connections
create:organization_discovery_domains: Create Organization Discovery Domains
create:organization_group_roles: Create Organization Group Roles
create:organization_invitations: Create Organization Invitations
create:organization_member_roles: Create Organization Member Roles
create:organization_members: Create Organization Members
create:organizations: Create Organizations
create:phone_providers: Create Phone Providers
create:phone_templates: Create Phone Templates
create:rate_limit_policies: Create Rate Limit Policies
create:resource_servers: Create Resource Servers
create:role_members: Create Role Members
create:roles: Create Roles
create:rules: Create Rules
create:scim_config: Create Scim Config
create:scim_token: Create Scim Token
create:self_service_profiles: Create Self Service Profiles
create:signing_keys: Create Signing Keys
create:sso_access_tickets: Create Sso Access Tickets
create:token_exchange_profiles: Create Token Exchange Profiles
create:user_attribute_profiles: Create User Attribute Profiles
create:user_tickets: Create User Tickets
create:users: Create Users
create:vdcs_templates: Create Vdcs Templates
delete:actions: Delete Actions
delete:anomaly_blocks: Delete Anomaly Blocks
delete:authentication_methods: Delete Authentication Methods
delete:branding: Delete Branding
delete:client_credentials: Delete Client Credentials
delete:client_grants: Delete Client Grants
delete:clients: Delete Clients
delete:connection_profiles: Delete Connection Profiles
delete:connections: Delete Connections
delete:current_user: Delete Current User
delete:current_user_device_credentials: Delete Current User Device Credentials
delete:custom_domains: Delete Custom Domains
delete:custom_signing_keys: Delete Custom Signing Keys
delete:device_credentials: Delete Device Credentials
delete:directory_provisionings: Delete Directory Provisionings
delete:email_provider: Delete Email Provider
delete:encryption_keys: Delete Encryption Keys
delete:event_streams: Delete Event Streams
delete:experimentation: Delete Experimentation
delete:federated_connections_tokens: Delete Federated Connections Tokens
delete:flows: Delete Flows
delete:flows_executions: Delete Flows Executions
delete:flows_vault_connections: Delete Flows Vault Connections
delete:forms: Delete Forms
delete:grants: Delete Grants
delete:group_roles: Delete Group Roles
delete:groups: Delete Groups
delete:guardian_enrollments: Delete Guardian Enrollments
delete:hooks: Delete Hooks
delete:log_streams: Delete Log Streams
delete:network_acls: Delete Network Acls
delete:organization_client_grants: Delete Organization Client Grants
delete:organization_connections: Delete Organization Connections
delete:organization_discovery_domains: Delete Organization Discovery Domains
delete:organization_group_roles: Delete Organization Group Roles
delete:organization_invitations: Delete Organization Invitations
delete:organization_member_roles: Delete Organization Member Roles
delete:organization_members: Delete Organization Members
delete:organizations: Delete Organizations
delete:phone_providers: Delete Phone Providers
delete:phone_templates: Delete Phone Templates
delete:rate_limit_policies: Delete Rate Limit Policies
delete:refresh_tokens: Delete Refresh Tokens
delete:resource_servers: Delete Resource Servers
delete:role_members: Delete Role Members
delete:roles: Delete Roles
delete:rules: Delete Rules
delete:rules_configs: Delete Rules Configs
delete:scim_config: Delete Scim Config
delete:scim_token: Delete Scim Token
delete:self_service_profiles: Delete Self Service Profiles
delete:sessions: Delete Sessions
delete:sso_access_tickets: Delete Sso Access Tickets
delete:token_exchange_profiles: Delete Token Exchange Profiles
delete:user_attribute_profiles: Delete User Attribute Profiles
delete:users: Delete Users
delete:vdcs_templates: Delete Vdcs Templates
read:actions: Read Actions
read:anomaly_blocks: Read Anomaly Blocks
read:attack_protection: Read Attack Protection
read:authentication_methods: Read Authentication Methods
read:branding: Read Branding
read:client_credentials: Read Client Credentials
read:client_grants: Read Client Grants
read:client_keys: Read Client Keys
read:client_summary: Read Client Summary
read:clients: Read Clients
read:connection_profiles: Read Connection Profiles
read:connections: Read Connections
read:connections_keys: Read Connections Keys
read:current_user: Read Current User
read:custom_domains: Read Custom Domains
read:custom_signing_keys: Read Custom Signing Keys
read:device_credentials: Read Device Credentials
read:directory_provisionings: Read Directory Provisionings
read:email_provider: Read Email Provider
read:email_templates: Read Email Templates
read:encryption_keys: Read Encryption Keys
read:event_deliveries: Read Event Deliveries
read:event_streams: Read Event Streams
read:events: Read Events
read:experimentation: Read Experimentation
read:federated_connections_tokens: Read Federated Connections Tokens
read:flows: Read Flows
read:flows_executions: Read Flows Executions
read:flows_vault_connections: Read Flows Vault Connections
read:forms: Read Forms
read:grants: Read Grants
read:group_members: Read Group Members
read:group_roles: Read Group Roles
read:groups: Read Groups
read:guardian_enrollments: Read Guardian Enrollments
read:guardian_factors: Read Guardian Factors
read:hooks: Read Hooks
read:log_streams: Read Log Streams
read:logs: Read Logs
read:logs_users: Read Logs Users
read:mfa_policies: Read Mfa Policies
read:network_acls: Read Network Acls
read:organization_client_grants: Read Organization Client Grants
read:organization_connections: Read Organization Connections
read:organization_discovery_domains: Read Organization Discovery Domains
read:organization_group_roles: Read Organization Group Roles
read:organization_groups: Read Organization Groups
read:organization_invitations: Read Organization Invitations
read:organization_member_effective_roles: Read Organization Member Effective Roles
read:organization_member_role_source_groups: Read Organization Member Role Source Groups
read:organization_member_roles: Read Organization Member Roles
read:organization_members: Read Organization Members
read:organizations: Read Organizations
read:organizations_summary: Read Organizations Summary
read:phone_providers: Read Phone Providers
read:phone_templates: Read Phone Templates
read:prompts: Read Prompts
read:rate_limit_policies: Read Rate Limit Policies
read:refresh_tokens: Read Refresh Tokens
read:resource_servers: Read Resource Servers
read:role_members: Read Role Members
read:roles: Read Roles
read:rules: Read Rules
read:rules_configs: Read Rules Configs
read:scim_config: Read Scim Config
read:scim_token: Read Scim Token
read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
read:self_service_profiles: Read Self Service Profiles
read:sessions: Read Sessions
read:signing_keys: Read Signing Keys
read:stats: Read Stats
read:tenant_settings: Read Tenant Settings
read:token_exchange_profiles: Read Token Exchange Profiles
read:user_attribute_profiles: Read User Attribute Profiles
read:user_effective_permissions: Read User Effective Permissions
read:user_effective_roles: Read User Effective Roles
read:user_idp_tokens: Read User Idp Tokens
read:user_permission_source_roles: Read User Permission Source Roles
read:user_role_source_groups: Read User Role Source Groups
read:users: Read Users
read:vdcs_templates: Read Vdcs Templates
update:actions: Update Actions
update:attack_protection: Update Attack Protection
update:authentication_methods: Update Authentication Methods
update:branding: Update Branding
update:client_credentials: Update Client Credentials
update:client_grants: Update Client Grants
update:client_keys: Update Client Keys
update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
update:clients: Update Clients
update:connection_profiles: Update Connection Profiles
update:connections: Update Connections
update:connections_keys: Update Connections Keys
update:current_user_identities: Update Current User Identities
update:current_user_metadata: Update Current User Metadata
update:custom_domains: Update Custom Domains
update:custom_signing_keys: Update Custom Signing Keys
update:directory_provisionings: Update Directory Provisionings
update:email_provider: Update Email Provider
update:email_templates: Update Email Templates
update:encryption_keys: Update Encryption Keys
update:event_deliveries: Update Event Deliveries
update:event_streams: Update Event Streams
update:experimentation: Update Experimentation
update:flows: Update Flows
update:flows_vault_connections: Update Flows Vault Connections
update:forms: Update Forms
update:guardian_factors: Update Guardian Factors
update:hooks: Update Hooks
update:log_streams: Update Log Streams
update:mfa_policies: Update Mfa Policies
update:network_acls: Update Network Acls
update:organization_connections: Update Organization Connections
update:organization_discovery_domains: Update Organization Discovery Domains
update:organizations: Update Organizations
update:phone_providers: Update Phone Providers
update:phone_templates: Update Phone Templates
update:prompts: Update Prompts
update:rate_limit_policies: Update Rate Limit Policies
update:refresh_tokens: Update Refresh Tokens
update:resource_servers: Update Resource Servers
update:roles: Update Roles
update:rules: Update Rules
update:rules_configs: Update Rules Configs
update:scim_config: Update Scim Config
update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
update:self_service_profiles: Update Self Service Profiles
update:sessions: Update Sessions
update:signing_keys: Update Signing Keys
update:tenant_settings: Update Tenant Settings
update:token_exchange_profiles: Update Token Exchange Profiles
update:user_attribute_profiles: Update User Attribute Profiles
update:users: Update Users
update:users_app_metadata: Update Users App Metadata
update:vdcs_templates: Update Vdcs Templates
tokenUrl: /oauth/token/
x-form-parameters:
audience: /api/v2/
type: oauth2
````