Configuration requise
Configuration Auth0 requise – Assurez-vous que votre locataire est configuré avec l’
API My Organization. Afficher le guide de configuration
→
Installation
L’exécution de la commande shadcn installe également la dépendance @auth0/universal-components-core
pour les utilitaires partagés et l’intégration Auth0.
Démarrage rapide
Exemple d’intégration complète
Exemple d’intégration complète
Bien que cet exemple utilise une application à page unique React, les configurations des propriétés (schéma, customMessages, style, etc.) s’appliquent également aux configurations Next.js et shadcn.
Propriétés
Propriétés essentielles
Les propriétés essentielles sont fondamentales pour le fonctionnement du composant.SsoProviderEdit nécessite l’identifiant du fournisseur pour charger et modifier le bon fournisseur.
| Propriété | Type | Description |
|---|---|---|
providerId | string | Obligatoire. Identifiant du fournisseur SSO à modifier. |
Propriétés d’affichage
Les propriétés d’affichage contrôlent la manière dont le composant s’affiche sans altérer son comportement.| Propriété | Type | Description |
|---|---|---|
hideHeader | boolean | Masquer la section d’en-tête. Valeur par défaut : false |
Propriétés d’action
Les interactions utilisateur entre les trois onglets sont gérées par plusieurs propriétés d’action organisées sous le nom de l’onglet correspondant (sso, provisioning et domains).
backButton
Type :{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }
Configure le bouton de retour dans l’en-tête du composant. À utiliser pour revenir à la liste de vos fournisseurs.
Propriétés :
icon– Composant icône Lucide personnalisé (facultatif, valeur par défaut : ArrowLeft)onClick– Gestionnaire de clic pour la navigation
Actions de l’onglet SSO
La propriétésso configure les actions de l’onglet Paramètres SSO. Cet onglet gère la configuration de l’authentification du fournisseur.
| Action | Type | Description |
|---|---|---|
updateAction | ComponentAction<IdentityProvider, IdentityProvider> | Mettre à jour les paramètres du fournisseur. Détails |
deleteAction | ComponentAction<IdentityProvider> | Supprimer définitivement le fournisseur. Détails |
removeFromOrganizationAction | ComponentAction<IdentityProvider> | Supprimer de l’organization. Détails |
sso.updateAction
Type :ComponentAction<IdentityProvider, IdentityProvider>
Contrôle l’enregistrement des modifications apportées à la configuration du fournisseur (identifiant client, secrets, certificats, etc.).
Propriétés :
disabled– Désactiver le bouton d’enregistrementonBefore(provider)– S’exécute avant la mise à jour. Renvoiefalsepour empêcher l’enregistrement (p. ex., pour afficher une fenêtre de confirmation).onAfter(provider, result)– S’exécute après la réussite de la mise à jour du fournisseur. À utiliser pour afficher une notification ou suivre l’événement.
sso.deleteAction
Type :ComponentAction<IdentityProvider>
Contrôle la suppression définitive du fournisseur de votre locataire Auth0.
Exemple :
sso.removeFromOrganizationAction
Type :ComponentAction<IdentityProvider>
Contrôle la suppression d’un fournisseur de l’organization sans le supprimer définitivement. Le fournisseur reste utilisable et peut être réajouté ultérieurement.
Exemple :
Actions de l’onglet Fourniture
La propriétéprovisioning configure les actions de l’onglet Fourniture SCIM. Cet onglet gère la fourniture automatisée des utilisateurs via le protocole SCIM.
| Action | Type | Description |
|---|---|---|
createAction | ComponentAction<IdentityProvider, CreateIdPProvisioningConfigResponseContent> | Activer la fourniture SCIM. Détails |
deleteAction | ComponentAction<IdentityProvider> | Désactiver la fourniture SCIM. Détails |
createScimTokenAction | ComponentAction<IdentityProvider, CreateIdpProvisioningScimTokenResponseContent> | Générer un jeton SCIM. Détails |
deleteScimTokenAction | ComponentAction<IdentityProvider> | Révoquer un jeton SCIM. Détails |
provisioning.createAction
Type :ComponentAction<IdentityProvider, CreateIdPProvisioningConfigResponseContent>
Active la fourniture SCIM pour le fournisseur. Après l’activation, vous pouvez générer un jeton SCIM à utiliser par votre fournisseur d’identité.
Exemple :
provisioning.deleteAction
Type :ComponentAction<IdentityProvider>
Désactive la fourniture SCIM et supprime toute configuration de fourniture pour ce fournisseur d’identité.
Exemple :
provisioning.createScimTokenAction
Type :ComponentAction<IdentityProvider, CreateIdpProvisioningScimTokenResponseContent>
Génère un nouveau jeton SCIM pour votre fournisseur d’identité afin de vous authentifier avec Auth0.
Exemple :
provisioning.deleteScimTokenAction
Type :ComponentAction<IdentityProvider>
Révoque le jeton SCIM. Le fournisseur d’identité ne pourra plus synchroniser les utilisateurs tant qu’un nouveau jeton n’aura pas été généré.
Exemple :
Actions de l’onglet Domaines
La propriétédomains configure les actions de l’onglet Domaines. Cet onglet gère les domaines associés au fournisseur pour le routage automatique des utilisateurs.
| Action | Type | Description |
|---|---|---|
createAction | ComponentAction<Domain> | Ajouter un domaine. Détails |
verifyAction | ComponentAction<Domain> | Vérifier le propriétaire du domaine. Détails |
deleteAction | ComponentAction<Domain> | Supprimer un domaine. Détails |
associateToProviderAction | ComponentAction<Domain, IdentityProvider | null> | Associer un domaine à un fournisseur. Détails |
deleteFromProviderAction | ComponentAction<Domain, IdentityProvider | null> | Supprimer le domaine du fournisseur. Détails |
domains.createAction
Type :ComponentAction<Domain>
Contrôle l’ajout de nouveaux domaines à l’organization à partir de l’interface d’édition du fournisseur.
Exemple :
domains.verifyAction
Type :ComponentAction<Domain>
Contrôle la vérification du domaine via l’enregistrement DNS TXT.
Exemple :
domains.deleteAction
Type :ComponentAction<Domain>
Contrôle la suppression de domaines.
Exemple :
domains.associateToProviderAction
Type :ComponentAction<Domain, IdentityProvider | null>
Associe un domaine vérifié à ce fournisseur SSO pour le routage automatique des utilisateurs.
Exemple :
domains.deleteFromProviderAction
Type :ComponentAction<Domain, IdentityProvider | null>
Supprime l’association d’un domaine avec ce fournisseur.
Propriétés de personnalisation
Les propriétés de personnalisation vous permettent d’adapter le composant à votre marque, à votre région et à vos exigences de validation sans modifier le code source.schéma
Définissez des règles de validation personnalisées pour les champs fournisseur et domaine.Champs de schéma disponibles
Champs de schéma disponibles
Tous les champs du schéma prennent en charge :
regex, errorMessage, minLength, maxLength, requiredfournisseur.* – Champs de configuration du fournisseur par stratégie– Common: name, displayName
– Champs propres à la stratégie (comme SsoProviderCreate)domains.create.domainUrl – Validation de l’URL du domainecustomMessages
Personaliser tous les textes et toutes les traductions. Tous les champs sont facultatifs et utilisent les valeurs par défaut s’ils ne sont pas renseignés.Messages disponibles
Messages disponibles
en-tête – En-tête de composant
title,back_button_text
sso,provisioning,domains
title,descriptionfields.*- Form field labels by strategyactions.save_button_text,actions.delete_button_textdelete_modal.*,remove_modal.*
title,descriptionscim_endpoint.label,scim_token.labelactions.enable_button_text,actions.disable_button_textactions.generate_token_button_text,actions.revoke_token_button_text
title, description
– Même structure que les messages DomainTablenotifications – Réponses API– provider_update_success, provider_delete_success
– provisioning_enable_success, provisioning_disable_success
– scim_token_create_success, scim_token_delete_success
– Notifications liées au domainestyle
Personnaliser l’apparence à l’aide de variables CSS et de remplacements de classe. Prend en charge les styles adaptés aux thèmes.Options de styles disponibles
Options de styles disponibles
Variables – Propriétés personnalisées CSS
–
common – Appliqué à tous les thèmes
– light – Thème clair uniquement
– dark – Thème sombre uniquementClasses – Remplacements de classes des composants– SsoProviderEdit-header
– SsoProviderEdit-tabs
– SsoProviderEdit-ssoTab
– SsoProviderEdit-provisioningTab
– SsoProviderEdit-domainsTabPersonnalisation avancée
Le composantSsoProviderTableest constitué de sous-composants et de hooks plus petits. Vous pouvez les importer individuellement pour créer des flux de production d’édition de fournisseurs personnalisés si vous utilisez shadcn.
Sous-composants disponibles
Pour les cas d’utilisation avancés, vous pouvez importer des sous-composants individuels afin d’intégrer des sections ou des onglets particuliers dans différents contextes.| Composant | Description |
|---|---|
SsoProviderSsoTab | Formulaire de configuration SSO |
SsoProviderProvisioningTab | Gestion de la fourniture SCIM |
SsoProviderDomainsTab | Gestion de l’association de domaines |
ProviderConfigureFields | Champs de formulaire dynamiques par stratégie |
ScimTokenDisplay | Affichage du jeton SCIM avec fonctionnalité de copie |
Hooks disponibles
Ces hooks fournissent la logique sous-jacente sans aucune interface utilisateur. Veuillez les utiliser pour créer des interfaces entièrement personnalisées tout en tirant parti de l’intégration de l’API Auth0.| Hook | Description |
|---|---|
useSsoProviderEdit | Logique de chargement et de mise à jour du fournisseur |
useSsoProviderProvisioning | Gestion de la fourniture SCIM |
useSsoProviderDomains | Gestion de l’association de domaines |