Configuration d'AWS Cognito

Configurez un écran de connexion AWS Cognito 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é en utilisant AWS Cognito, le processus se présente comme suit :

1

Créer une nouvelle application AWS Cognito

Créez une application AWS Cognito depuis votre tableau de bord AWS.

2

Installer et configurer l'intégration AWS Cognito

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

3

Configurer AWS Cognito pour le contenu adaptatif (optionnel)

Configurez AWS Cognito pour fonctionner avec le contenu adaptatif dans GitBook.

Créer une nouvelle application AWS Cognito

Accédez à votre User Pool souhaité dans Cognito, et cliquez sur App integration. Notez le domaine Cognito, nous en aurons besoin pour configurer l'intégration.

Faites défiler jusqu'en bas et cliquez sur "Create app client". Pour le type d'application, sélectionnez "Confidential client." Faites défiler jusqu'aux paramètres Hosted UI. Dans Allowed Callback URLs, saisissez l'URL de callback que vous avez obtenue de GitBook lors de l'installation de l'intégration sur un espace.

Faites défiler plus bas jusqu'à "OAuth 2.0 grant types" - assurez-vous que "Authorization code grant" est sélectionné.

Pour "OpenID connect scopes", assurez-vous que OpenID est sélectionné.

Faites défiler vers le bas et cliquez sur "Create app client".

Cliquez sur l'app client créé et notez le Client ID et le Client Secret.

Installer et configurer l'intégration AWS Cognito

Accédez aux intégrations dans l'application GitBook, sélectionnez authenticated access comme catégorie, et installez l'intégration AWS Cognito.

Une fois que vous l'avez installée sur votre site, allez dans la configuration et notez l'URL de callback juste au-dessus du bouton Enregistrer. Nous en aurons besoin pour configurer Cognito.

Ouvrez l'écran de configuration de l'intégration Cognito pour l'espace sur lequel vous avez installé l'intégration.

Cela devrait ressembler à l'image suivante :

Pour Client ID, Cognito Domain et Client Secret, collez les valeurs que vous avez obtenues de Cognito.

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 Cognito 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 Visit. Il vous sera demandé de vous connecter avec Cognito, ce qui confirme que votre site est publié derrière un accès authentifié utilisant Auth0.

Configurer AWS Cognito pour le contenu adaptatif (optionnel)

Pour exploiter le contenu adaptatif avec un accès authentifié dans GitBook, vous devrez configurer votre user pool Amazon Cognito pour inclure des claims personnalisés dans le token ID.

Ceci se fait généralement en créant un déclencheur Lambda Cognito—plus précisément un Lambda Pre Token Generation —qui renvoie une charge utile JSON remplaçant ou ajoutant des claims personnalisés. Ces claims peuvent inclure des rôles d'utilisateur, des niveaux d'abonnement ou toute autre métadonnée pertinente pour votre contenu.

Voici un exemple de ce à quoi cela pourrait ressembler :

export const handler = async (event, context) => {
  // Récupérer un attribut utilisateur depuis la requête d'événement
  const userAttributes = event.request.userAttributes;

  // Ajouter des claims supplémentaires à la réponse d'événement
  event.response = {
    "claimsAndScopeOverrideDetails": {
      "idTokenGeneration": {},
      "accessTokenGeneration": {
        "claimsToAddOrOverride": {
          "products": ['api', 'sites', 'askAI'],
          "isBetaUser": true,
          "isAlphaUser": true,
        }
      }
    }
  };
  // Retourner à Amazon Cognito
  context.done(null, event);
};

Une fois ajoutées, ces paires clé-valeur sont incluses dans le token d'authentification et transmises à GitBook, permettant à votre site d'adapter dynamiquement son contenu en fonction du profil de l'utilisateur authentifié.