Configuration d’OIDC

Configurez un écran de connexion OIDC 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’OIDC, le processus est le suivant :

1

Créez une nouvelle application auprès de votre fournisseur d’identité

Créez une application à partir du tableau de bord de votre fournisseur d’identité.

2

Installez et configurez l’intégration OIDC

Installez l’intégration Auth0 et ajoutez la configuration requise.

OIDC signifie OpenID Connect, et il s’agit d’une couche d’identité construite au-dessus d’OAuth. De nombreux fournisseurs d’identité se conforment à OIDC, et l’intégration OIDC de GitBook pour l’accès authentifié vous permet de publier votre contenu derrière un accès authentifié, l’accès au contenu étant नियंत्रlé par votre fournisseur d’identité

Comme ce guide est un guide générique destiné à tous les fournisseurs d’identité, certains détails peuvent varier selon votre fournisseur d’identité. À titre d’exemple, nous utilisons Google comme fournisseur d’identité dans ce guide.

Créez une nouvelle application auprès de votre fournisseur d’identité

Vous devez configurer certaines choses chez votre fournisseur d’identité afin que l’intégration fonctionne.

Vous devez créer une nouvelle application dans votre fournisseur d’identité. Son type doit être « Application Web ». Dans Google, vous les créez sous « API et services », « Identifiants », puis sous « ID clients OAuth 2.0 ».\

Cliquez sur Créer des identifiants, sélectionnez ID client OAuth, sélectionnez Application Web comme type, nommez-la de manière appropriée, puis, dans URI de redirection autorisés, saisissez l’URL de rappel que vous avez obtenue de GitBook.

Cliquez sur Créer. Notez l’ID client et le secret client. Nous en aurons besoin pour terminer la configuration de notre intégration dans GitBook.

Installez et configurez l’intégration OIDC

Accédez aux intégrations dans l’application GitBook, sélectionnez l’accès authentifié comme catégorie, puis installez l’intégration OIDC. Installez l’intégration OIDC sur le site de documentation de votre choix.

Une fois installée sur votre site, allez dans la configuration et notez l’URL de rappel juste au-dessus du bouton Enregistrer. Nous pourrions en avoir besoin pour configurer le fournisseur d’identité.

Ouvrez l’écran de configuration de l’intégration OIDC pour la section sur laquelle vous avez installé l’intégration.

Cela devrait ressembler à l’image suivante

Pour l’ID client et le secret client, collez les valeurs que vous avez obtenues pour votre fournisseur d’identité.

Vous devez maintenant trouver le point de terminaison d’autorisation et le point de terminaison du jeton d’accès pour votre fournisseur d’identité. Pour Google, ce sont https://accounts.google.com/o/oauth2/v2/auth et https://oauth2.googleapis.com/token respectivement.

Si vous n’utilisez pas Google, ces points de terminaison seront différents pour vous. Veuillez consulter la documentation de votre fournisseur d’identité pour les localiser

Pour la portée OAuth, sa valeur sera à nouveau différente selon votre fournisseur d’identité. Dans le cas de Google, vous pouvez saisir openid.

Veuillez consulter la liste des portées autorisées dans la documentation de votre fournisseur d’identité, et saisissez la valeur de la portée la moins permissive. Nous utilisons uniquement le jeton d’accès pour vérifier que l’utilisateur est authentifié, et nous n’utilisons pas le jeton d’accès pour récupérer d’autres informations. Ainsi, saisir la portée la moins permissive est la meilleure recommandation en matière de sécurité.

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é, puis choisissez OIDC comme backend. Ensuite, cliquez sur Mettre à jour l’audience. Accédez à 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 OIDC, ce qui confirme que votre site est publié derrière un accès authentifié à l’aide d’Auth0.

Activer PKCE

Si votre fournisseur d’identité exige ou recommande PKCE, activez Utiliser PKCE dans l’écran de configuration de l’intégration OIDC. Cette option active Proof Key for Code Exchange (PKCE) pour le flux du code d’autorisation que l’intégration initie avec votre fournisseur d’authentification.