Configuration d’Okta

Configurez un écran de connexion Okta pour les visiteurs de vos docs

Pour configurer votre site GitBook avec un accès authentifié en utilisant Okta, le processus est le suivant :

1

Créer une nouvelle application Okta

Créez une application Okta depuis votre tableau de bord Okta.

2

Installer et configurer l'intégration Okta

Installez l'intégration Okta et ajoutez la configuration requise.

3

Configurer Okta pour le contenu adaptatif (optionnel)

Configurez Okta pour fonctionner avec le contenu adaptatif dans GitBook.

Créer une nouvelle application Okta

Tout d'abord, connectez-vous à la plateforme Okta (version administrateur) et créez une nouvelle intégration d'application (ou utilisez-en une existante) en cliquant sur le bouton Applications dans la barre latérale gauche.

An Okta screenshot showing the create app integration screen

Cliquez sur Créer une intégration d'application et sélectionnez OIDC - OpenID Connect comme méthode de connexion. Puis sélectionnez Application Web comme type d'application.

An Okta screenshot showing the integration setup

Donnez-lui un nom approprié et ne modifiez aucun autre paramètre sur cette page. Pour les attributions, cochez la case appropriée. Cliquez sur Enregistrer.

À l'écran suivant, copiez l'ID client et le secret client. Copiez le domaine Okta juste en dessous de votre adresse e-mail en cliquant sur le menu déroulant en haut à droite.

An Okta screenshot showing where to copy client credentials

Nous aurons besoin de ces valeurs pour configurer l'intégration Okta.

Installer et configurer l'intégration Okta

Accédez à l'onglet Intégrations sur le site que vous souhaitez publier et localisez l'intégration Okta.

A GitBook screenshot showing the site settings page

Installez l'intégration sur votre site.

Après l'installation sur le site, vous verrez un écran vous demandant de saisir l'ID client, le domaine Okta et le secret client.

A GitBook screenshot showing the Okta credentials modal

Pour l'ID client, le domaine Okta (supprimez https://préfixe, le cas échéant) et le secret client, collez la valeur que vous avez copiée depuis le tableau de bord Okta.

Cliquez sur Enregistrer.

Copiez l'URL affichée dans la fenêtre modale et saisissez-la en tant qu'URI de redirection de connexion dans Okta (comme montré dans la capture d'écran ci-dessous). Appuyez sur Enregistrer.

An Okta screenshot showing the sign-in redirect URI configuration

Maintenant, dans GitBook, fermez la fenêtre modale des intégrations et cliquez sur le bouton Gérer le site. Accédez à Audience, sélectionnez Accès authentifié, et choisissez Okta comme backend. Ensuite, cliquez sur Mettre à jour l'audience. Allez sur l'écran du site et cliquez sur Publier. Le site est maintenant publié derrière un accès authentifié contrôlé par votre application Auth0. Pour l'essayer, cliquez sur Visiter. Il vous sera demandé de vous connecter avec Okta, ce qui confirme que votre site est publié derrière un accès authentifié en utilisant Auth0.

Configurer Okta pour le contenu adaptatif (optionnel)

Pour activer le contenu adaptatif sur votre site GitBook avec un accès authentifié, vous devrez configurer votre application Okta pour inclure les données utilisateur pertinentes en tant que claims dans le jeton d'authentification.

Les claims sont des paires clé-valeur intégrées dans le jeton envoyé à GitBook. Ces claims peuvent être utilisés pour adapter dynamiquement la documentation en fonction du rôle de l'utilisateur, de son abonnement, de son emplacement ou de tout autre attribut d'identification.

Okta prend en charge plusieurs types de claims :

  • Claims standard Ce sont des claims courants (comme e-mail, nom, ou groupes) qui peuvent être inclus par défaut mais doivent souvent être ajoutés explicitement à la configuration de votre jeton pour en assurer la disponibilité constante.

  • Claims personnalisés Vous pouvez définir des claims personnalisés dans Okta en utilisant attributs utilisateur personnalisés ou une logique basée sur des expressions. Ceux-ci vous permettent de transmettre des valeurs très spécifiques — comme le niveau d'abonnement, l'ID de compte ou des indicateurs d'équipe interne.

  • Groupes en tant que claims Vous pouvez également transmettre des groupes Okta en tant que claims, ce qui est particulièrement utile lors de la définition de segments d'audience tels que « utilisateurs entreprise » ou « testeurs bêta ». Ceux-ci peuvent être filtrés et mappés dans la configuration des claims de votre serveur d'autorisation.

Pour ajouter ou personnaliser les claims dans Okta :

  1. Ouvrez votre console d'administration Okta.

  2. Accédez à Sécurité > API > Serveurs d'autorisation.

  3. Modifiez le serveur d'autorisation utilisé pour votre site GitBook.

  4. Sous l'onglet Claims , ajoutez des règles pour inclure les claims souhaités dans le jeton.

  5. Assurez-vous que votre site GitBook lit et mappe correctement ces claims.

Une fois que les claims sont transmis à GitBook, suivez les étapes dans Adapter votre contenu pour définir quel contenu doit être affiché à qui.

Mis à jour

Ce contenu vous a-t-il été utile ?