Configuration d’OIDC

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

Ce guide vous explique comment configurer un écran de connexion protégé pour vos documents. Avant de suivre ce guide, assurez-vous d'avoir d'abord suivi le processus d'activation de l'accès authentifié.

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

1

Créez 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

Installez et configurez 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é, et l'accès au contenu est contrô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é

Il y a certaines choses que vous devez configurer sur 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, sélectionnez Application Web comme type, nommez-la de manière appropriée, et sous 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 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'ID client et le secret client, collez les valeurs que vous avez obtenues de votre fournisseur d'identité.

Vous devrez maintenant trouver l'endpoint d'autorisation et l'endpoint 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 endpoints seront différents pour vous. Veuillez consulter la documentation de votre fournisseur d'identité pour localiser ces endpoints.

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 de sécurité.

Cliquez sur Enregistrer.

Maintenant, dans GitBook, fermez la fenêtre des intégrations et cliquez sur le bouton Gérer le site. Accédez à Audience, sélectionnez Accès authentifié, et choisissez OIDC 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 OIDC, ce qui confirme que votre site est publié derrière un accès authentifié utilisant Auth0.