Configuration d’AWS Cognito

Configurez un écran de connexion AWS Cognito 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 effectué 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 est le suivant :

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

Allez dans le User Pool souhaité dans Cognito, puis cliquez sur Intégration d'application. Notez le domaine Cognito, nous en aurons besoin pour configurer l'intégration.

Faites défiler jusqu'en bas et cliquez sur « Créer un client d'application ». Pour le type d'application, sélectionnez « Client confidentiel ». Descendez jusqu'aux paramètres de l'interface hébergée. Dans les URLs de rappel autorisées, saisissez l'URL de rappel obtenue de GitBook lors de l'installation de l'intégration sur un espace.

Faites défiler plus bas jusqu'à « Types de subventions OAuth 2.0 » – assurez-vous que « Autorisation par code » est sélectionné.

Pour « Scopes OpenID Connect », assurez-vous qu'OpenID est sélectionné.

Faites défiler vers le bas et cliquez sur « Créer un client d'application ».

Cliquez sur le client d'application créé et notez l'ID client et le secret client.

Installer et configurer l'intégration AWS Cognito

Accédez aux intégrations dans l'application GitBook, sélectionnez l'accès authentifié comme catégorie, puis installez l'intégration AWS Cognito.

Une fois installée sur votre site, allez dans la configuration et notez l'URL de rappel 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 l'ID client, le domaine Cognito et le secret client, collez les valeurs obtenues depuis Cognito.

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 Cognito 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 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 pool d'utilisateurs Amazon Cognito pour inclure des revendications personnalisées dans le jeton ID.

Cela se fait généralement en créant un déclencheur Lambda Cognito—plus précisément un Pré-génération de jeton Lambda—qui retourne une charge utile JSON remplaçant ou ajoutant des revendications personnalisées. Ces revendications peuvent inclure des rôles 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 l'attribut utilisateur depuis la requête d'événement
  const userAttributes = event.request.userAttributes;

  // Ajouter des revendications supplémentaires à la réponse de l'é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 jeton d'authentification et transmises à GitBook, permettant à votre site d'adapter dynamiquement son contenu en fonction du profil de l'utilisateur authentifié.