Configuration d’Okta

Configurez un écran de connexion Okta pour les visiteurs de votre documentation

Ce guide vous accompagne dans la configuration d’un écran de connexion protégé pour vos docs. Avant de suivre ce guide, assurez-vous d’avoir d’abord suivi le processus de l’activation de l’accès authentifié.

Pour configurer votre site GitBook avec un accès authentifié à l’aide d’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 (facultatif)

Configurez Okta pour fonctionner avec le contenu adaptatif dans GitBook.

Créer une nouvelle application Okta

Commencez par vous connecter à la plateforme Okta (la 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.

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

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.

Sur l’écran suivant, copiez le Client ID et le Client Secret. Copiez le domaine Okta juste en dessous de votre adresse e-mail en cliquant sur le menu déroulant en haut à droite.

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

Installer et configurer l’intégration Okta

Accédez à l’onglet Integrations dans le site que vous souhaitez publier et localisez l’intégration Okta.

Installez l’intégration sur votre site.

Une fois l’intégration installée sur le site, vous verrez un écran vous demandant de saisir le Client ID, le domaine Okta et le Client Secret.

Pour le Client ID, le domaine Okta (supprimez https://le préfixe, le cas échéant) et le Client Secret, 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 comme URI de redirection de connexion dans Okta (comme indiqué dans la capture d’écran ci-dessous). Cliquez sur Enregistrer.

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. Accédez à l’écran du site et cliquez sur Publier. Le site est désormais 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é à l’aide d’Auth0.

Configurer Okta pour le contenu adaptatif (facultatif)

Pour activer le contenu adaptatif dans votre site GitBook avec un accès authentifié, vous devrez configurer votre application Okta afin d’inclure les données utilisateur pertinentes sous forme de 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, du plan, de la localisation ou de tout autre attribut d’identification de l’utilisateur.

Okta prend en charge plusieurs types de claims :

• Revendications standard Il s’agit de claims courants (comme email, name, ou groups) qui peuvent être inclus par défaut mais doivent souvent être ajoutés explicitement à la configuration de votre jeton pour être disponibles de manière cohérente.
• Revendications personnalisées Vous pouvez définir des claims personnalisés dans Okta à l’aide de attributs utilisateur personnalisés ou d’une logique basée sur des expressions. Cela vous permet de transmettre des valeurs très spécifiques, comme le niveau d’abonnement, l’ID de compte ou des indicateurs internes d’équipe.
• Groupes comme claims Vous pouvez également transmettre des groupes Okta comme claims, ce qui est particulièrement utile pour définir des segments d’audience comme « utilisateurs entreprise » ou « bêta-testeurs ». Ceux-ci peuvent être filtrés et mappés dans la configuration des claims de votre serveur d’autorisation.

Pour ajouter ou personnaliser des 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.