Configuration d’AWS Cognito

Configurez un écran de connexion AWS Cognito 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’abord d’avoir parcouru le processus de l’activation de l’accès authentifié.

Pour configurer votre site GitBook avec un accès authentifié à l’aide d’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 (facultatif)

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

Créer une nouvelle application AWS Cognito

Accédez au User Pool souhaité dans Cognito, puis cliquez sur App integration. Notez le domaine Cognito, nous en aurons besoin pour configurer l’intégration.

Faites défiler vers le 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 rappel que vous avez obtenue de GitBook lors de l’installation de l’intégration sur un espace.

Faites défiler encore 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 l’accès authentifié comme catégorie, puis installez l’intégration AWS Cognito.

Une fois l’intégration installée sur votre site, allez dans la configuration et notez l’URL de rappel juste au-dessus du bouton Save. 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 le Client ID, le domaine Cognito et le Client Secret, collez les valeurs obtenues depuis Cognito.

Cliquez sur Save.

Maintenant, dans GitBook, fermez la fenêtre modale des intégrations et cliquez sur le bouton Manage site. Accédez à Public, sélectionnez Accès authentifié, puis choisissez Cognito comme backend. Ensuite, cliquez sur Mettre à jour l’audience. Allez à 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 le tester, 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é à l’aide d’Auth0.

Configurer AWS Cognito pour le contenu adaptatif (facultatif)

Pour exploiter le contenu adaptatif avec l’accès authentifié dans GitBook, vous devrez configurer votre pool d’utilisateurs Amazon Cognito afin d’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 Pre Token Generation Lambda — qui renvoie une charge utile JSON remplaçant ou ajoutant des revendications personnalisées. Ces revendications 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 l’attribut utilisateur à partir de 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é.