Configuration d'OIDC

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

Ce guide vous emmène à travers la mise en place d’un écran de connexion protégé pour vos documents. Avant de suivre ce guide, assurez‑vous d’abord d’avoir suivi le processus de activation de l’accès authentifié.

Pour configurer votre site GitBook avec un accès authentifié utilisant OIDC, le processus se présente comme suit :

1

Créer une nouvelle application auprès de votre fournisseur d'identité

Créez une application depuis le tableau de bord de votre fournisseur d'identité.

2

Installer et configurer l'intégration OIDC

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

OIDC signifie OpenID Connect, et c'est une couche d'identité construite au‑dessus d'OAuth. De nombreux fournisseurs d'identité respectent OIDC, et l'intégration OIDC de GitBook pour l'accès authentifié vous permet de publier votre espace derrière un accès authentifié, l'accès au contenu étant contrôlé par votre fournisseur d'identité.

Puisque ce guide est un guide générique destiné à tous les fournisseurs d'identité, certains détails peuvent varier en fonction de votre fournisseur d'identité. À titre d'illustration, nous utilisons Google comme fournisseur d'identité dans ce guide.

Créer une nouvelle application auprès de votre fournisseur d'identité

Il y a quelques éléments que vous devez configurer 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 "Identifiants client OAuth 2.0".

Cliquez sur Créer des identifiants, sélectionnez ID client OAuth, choisissez Application Web comme type, donnez‑lui un nom approprié, et sous URI de redirection autorisés, saisissez l'URL de rappel que vous avez obtenue de GitBook.

Cliquez sur Créer. Notez l'identifiant client (Client ID) et le secret client (Client Secret). Nous aurons besoin de ces éléments pour terminer la configuration de notre intégration dans GitBook.

Installer et configurer l'intégration OIDC

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

Une fois que vous l'avez 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 l'espace sur lequel vous avez installé l'intégration.

Cela devrait ressembler à l'image suivante

Pour l'identifiant client (Client ID) et le secret client (Client Secret), collez les valeurs que vous avez obtenues auprès de votre fournisseur d'identité.

Maintenant, vous devrez trouver le point de terminaison d'autorisation (Authorization Endpoint) et le point de terminaison de jeton d'accès (Access Token Endpoint) 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 localiser ces points de terminaison

Pour la portée OAuth (OAuth Scope), sa valeur sera également différente selon votre fournisseur d'identité. Dans le cas de Google, vous pouvez entrer openid.

Veuillez consulter la liste des scopes autorisés dans la documentation de votre fournisseur d'identité, et saisissez la valeur du scope le moins permissif. Nous n'utilisons le jeton d'accès que 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, entrer le scope le moins permissif 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. Naviguez vers Audience, sélectionnez Accès authentifié, et choisissez OIDC comme backend. Puis cliquez Mettre à jour l'audience. Allez sur l'écran du site et cliquez 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é utilisant Auth0.