Skip to main content
El componente SsoProviderCreate ofrece una interfaz unificada para añadir nuevos proveedores de inicio de sesión único.

Requisitos de configuración

Se requiere configurar Auth0 - Asegúrese de que su inquilino esté configurado para usar la API My Organization. Ver guía de configuración →

Instalación

Al ejecutar cualquiera de los dos comandos, también se instala la dependencia @auth0/universal-components-core para utilidades compartidas e integración con Auth0.

Primeros pasos

Props

Props obligatorias

Las props obligatorias son fundamentales para el funcionamiento del componente. En SsoProviderCreate, solo hay una prop principal que controla qué sucede después de crear correctamente un proveedor.
PropTipoDescripción
createActionComponentAction<…>Obligatoria. Controla el flujo posterior a la creación.
createAction Tipo: ComponentAction<CreateIdentityProviderRequestContentPrivate, IdentityProvider> La prop createAction es obligatoria porque controla adónde se redirige a los usuarios después de crear correctamente un proveedor. Sin ella, el componente no sabría qué hacer a continuación. Propiedades:
  • disabled - Desactiva el botón de creación (por ejemplo, mientras hay otra operación en curso)
  • onBefore(data) - Se ejecuta antes de crear el proveedor. Devuelve false para impedir la creación (por ejemplo, para mostrar primero un cuadro de diálogo de confirmación).
  • onAfter(data, result) - Se ejecuta después de crear correctamente el proveedor. Úsalo para navegar a otra página o registrar el evento.
Ejemplo:

Props de visualización

Los props de visualización controlan cómo se renderiza el componente sin afectar su comportamiento. Úsalos para ocultar secciones o activar el modo de solo lectura.
PropTipoDescripción
readOnlybooleanDeshabilita todos los campos del formulario. Valor predeterminado: false
hideHeaderbooleanOculta la sección del encabezado. Valor predeterminado: false

Props de Action

Las props de Action manejan las interacciones del usuario más allá del flujo principal de creación. Controlan la navegación y el comportamiento de los pasos del asistente.
PropTipoDescripción
backButtonObjectConfiguración del botón para volver.
onNextFunctioncallback de navegación entre pasos.
onPreviousFunctioncallback de navegación entre pasos.
backButton Tipo: { icon?: LucideIcon; onClick: (e: MouseEvent) => void } Configura el botón para volver en el encabezado del componente. Úsalo para volver a tu lista de proveedores o a la página anterior. Propiedades:
  • icon - Componente de icono de Lucide personalizado (opcional; el valor predeterminado es ArrowLeft)
  • onClick - Controlador de clic para la navegación
Ejemplo:

onNext / onPrevious Tipo: (stepId: string, values: Partial<SsoProviderFormValues>) => boolean Controla la navegación entre los pasos del asistente. Estos callbacks se ejecutan cuando el usuario hace clic en Siguiente o Anterior. Devuelve false para impedir la navegación. Casos de uso:
  • Validar los datos del paso antes de continuar
  • Registrar eventos analíticos al completar pasos
  • Omitir pasos de forma condicional
Parámetros:
  • stepId - Identificador del paso actual ("provider-select", "provider-details", "provider-configure")
  • values - Valores actuales del formulario
Ejemplo:

Props de personalización

Los props de personalización te permiten adaptar el componente a tu marca, configuración regional y requisitos de validación sin modificar el código fuente.
PropTipoDescripción
schemaSsoProviderSchemaReglas de validación de campos.
customMessagesPartial<SsoProviderCreateMessages>Sobrescrituras de texto para i18n.
stylingComponentStyling<SsoProviderCreateClasses>Variables CSS y sobrescrituras de clases.
schema Configura reglas de validación personalizadas para los campos del proveedor. Las reglas se organizan por estrategia del proveedor (el protocolo de autenticación utilizado, como oidc, samlp, waad, google-apps, adfs, pingfederate u okta). Todos los campos admiten regex, errorMessage, minLength, maxLength y required.
Detalles del proveedor
  • name, displayName
Okta
  • okta.domain, okta.client_id, okta.client_secret, okta.icon_url, okta.callback_url
ADFS
  • adfs.meta_data_source, adfs.meta_data_location_url, adfs.adfs_server, adfs.fedMetadataXml
Google Workspace
  • google-apps.domain, google-apps.client_id, google-apps.client_secret, google-apps.icon_url, google-apps.callback_url
OIDC
  • oidc.type, oidc.client_id, oidc.client_secret, oidc.discovery_url, oidc.isFrontChannel
PingFederate
  • pingfederate.signatureAlgorithm, pingfederate.digestAlgorithm, pingfederate.signSAMLRequest, pingfederate.metadataUrl, pingfederate.signingCert, pingfederate.idpInitiated, pingfederate.icon_url
SAML
  • samlp.meta_data_source, samlp.single_sign_on_login_url, samlp.signatureAlgorithm, samlp.digestAlgorithm, samlp.protocolBinding, samlp.signSAMLRequest, samlp.bindingMethod, samlp.metadataUrl, samlp.cert, samlp.idpInitiated, samlp.icon_url
Azure AD
  • waad.domain, waad.client_id, waad.client_secret, waad.icon_url, waad.callback_url

customMessages Personaliza todos los textos y las traducciones. Todos los campos son opcionales y usan los valores predeterminados si no se proporcionan.
header - Encabezado del componente
  • title, back_button_text
provider_select - Paso 1
  • title, description
provider_details - Paso 2
  • title, description
  • fields.name - label, placeholder, helper_text, error
  • fields.display_name - label, placeholder, helper_text, error
provider_configure - Paso 3
  • title, description, guided_setup_button_text
  • fields.okta - Campos de Okta
  • fields.adfs - Campos de ADFS
  • fields.google-apps - Campos de Google Workspace
  • fields.oidc - Campos de OIDC
  • fields.pingfederate - Campos de PingFederate
  • fields.samlp - Campos de SAML
  • fields.waad - Campos de Azure AD
notifications - Respuestas de la API
  • general_error, provider_create_success

styling Personaliza la apariencia con variables CSS y sobrescrituras de clases. Admite estilos adaptados al tema.
Variables - propiedades personalizadas de CSS
  • common - Se aplica a todos los temas
  • light - Solo para el tema claro
  • dark - Solo para el tema oscuro
Clases - sobrescrituras de clases del componente
  • SsoProviderCreate-header
  • SsoProviderCreate-wizard
  • ProviderSelect-root
  • ProviderDetails-root
  • ProviderConfigure-root

Personalización avanzada

El componente SsoProviderCreate se compone de subcomponentes y hooks más pequeños. Puede importarlos por separado para crear flujos personalizados de creación de proveedores de SSO si usa shadcn.

Subcomponentes disponibles

Para casos de uso avanzados, puedes importar subcomponentes individuales para crear flujos de trabajo personalizados para la creación de proveedores de SSO. Esto resulta útil cuando necesitas integrar un solo paso en una interfaz de usuario diferente o personalizar el flujo del asistente más allá de lo que permiten las props.
ComponenteDescripción
ProviderSelectPaso de selección de estrategia con iconos de proveedores
ProviderDetailsPaso de configuración del nombre y del nombre para mostrar
ProviderConfigurePaso de configuración específico de la estrategia
ProviderConfigureFieldsCampos de formulario dinámicos según la estrategia
OktaProviderFormFormulario de configuración específico de Okta
AdfsProviderFormFormulario de configuración específico de ADFS
GoogleAppsProviderFormFormulario de configuración específico de Google Workspace
OidcProviderFormFormulario de configuración específico de OIDC
PingFederateProviderFormFormulario de configuración específico de PingFederate
SamlpProviderFormFormulario de configuración específico de SAML
WaadProviderFormFormulario de configuración específico de Azure AD
WizardInterfaz de asistente de varios pasos

Hooks disponibles

Estos hooks proporcionan la lógica subyacente sin interfaz de usuario. Úsalos para crear interfaces totalmente personalizadas aprovechando la integración con la API de Auth0.
HookDescripción
useSsoProviderCreateLógica de creación de proveedores e integración con la API