OAuth
OAuth est un cadre d'autorisation de pointe conçu pour accorder aux utilisateurs un accès sécurisé aux ressources sans partager leurs informations d'identification.
Largement adopté par les grandes entreprises technologiques et intégré à diverses applications, OAuth a révolutionné la façon dont les utilisateurs interagissent avec les services Web et mobiles.
L'authentification OAuth s'intègre parfaitement aux services tiers tout en protégeant les informations sensibles.
Profitez de la flexibilité et de la nature centrée sur l'utilisateur d'OAuth, qui permet aux utilisateurs d'accorder facilement l'accès à leurs données sans compromettre leurs informations de connexion.
- Dans votre espace de travail, accédez au Réglages alors Authentification
- Cliquez Ajouter et a choisi OAuth 2.0
- Parcourez la boîte de dialogue de configuration qui apparaît
Authentifiez-vous avec OAuth
Guide de mise en œuvre
OAuth 2.0 est le protocole d'autorisation standard de l'industrie. OAuth 2.0 met l'accent sur la simplicité des développeurs clients tout en fournissant des flux d'autorisation spécifiques pour des applications telles qu'Ideanote.
Ideanote prend en charge une version basée sur OAuth 2.0 Flux de codes d'autorisation. Il s'agit du type de subvention OAuth 2.0 le plus courant, et en ce qui concerne Ideanote, le flux se déroule à peu près comme suit :
- Ideanote redirige votre utilisateur vers un écran de connexion que vous contrôlez (ou auquel vous pouvez intégrer) et qu'il connaît déjà.
- L'utilisateur saisit ses informations d'identification et tente de s'authentifier.
- Si les informations d'identification sont valides, l'utilisateur sera redirigé vers Ideanote avec un code d'autorisation comme paramètre de requête dans l'URL.
- Ideanote échange ensuite ce code d'autorisation contre un jeton d'accès en communiquant avec votre API.
- En utilisant ce jeton d'accès comme autorisation, Ideanote extrait certaines informations utilisateur de votre API, telles que l'adresse e-mail, l'identifiant (ou sous-identifiant), l'avatar, les paramètres régionaux préférés et le nom.
Si vous souhaitez approfondir cette question plus en détail, c'est une excellente ressource sur le sujet.
Avantages
- Un moyen simple de garantir une authentification forte.
- Vos utilisateurs se connectent via un système auquel ils ont déjà confiance et ils ne partagent jamais leurs informations d'identification directement avec Ideanote.
- Au fur et à mesure que vos utilisateurs s'authentifient directement via votre système (ou un système que vous contrôlez), vous conserverez un contrôle total sur les personnes ayant accès à votre espace de travail Ideanote.
- OAuth 2.0 est une norme industrielle que vous pouvez utiliser pour vous authentifier non seulement avec Ideanote, mais aussi avec des milliers de solutions logicielles.
Prérequis
Vous devrez soit :
- Utilisez déjà un fournisseur de connexion pour votre propre système qui prend en charge OAuth 2.0, tel qu'Okta, Facebook, Google, Github et bien d'autres. Ou
- Exécutez vous-même un serveur d'authentification OAuth 2 conforme à la spécification OAuth 2.0
Remarque importante :
Pour commencer à utiliser l'authentification basée sur OAuth 2.0, vous devez d'abord consulter la documentation du fournisseur de connexion que vous utilisez pour votre système afin de créer une intégration ou une application OAuth via son interface.
À partir de là, vous devrez copier quelques éléments dans la configuration de votre espace de travail Ideanote, et vice versa. Nous aborderons les détails dans un instant.
Pour vous faciliter la tâche, nous avons préparé ci-dessous une petite liste de liens directs vers la documentation pertinente pour certains fournisseurs de connexion populaires prenant en charge OAuth 2.0 :
Leur fonctionnement varie généralement de la manière suivante : Vous créez une application ou une intégration OAuth. À l'intérieur, vous verrez un Identifiant du client et un Secret du client, ainsi qu'une liste de Portées OAuth il soutient. Vous pourrez également saisir une ou plusieurs URL de redirection. Enfin, vous devriez voir une liste des points de terminaison d'API pertinents, tels que le Endpoint d'autorisation et Token Endpoint.
Ces images sont des exemples d'intégrations d'OAuth 2.0. Le premier provient de Github et le second de Facebook/Meta.
Lorsque vous avez créé une application/intégration OAuth, ou si vous hébergez votre propre serveur d'autorisation OAuth 2.0, vous pouvez maintenant passer à sa configuration sur votre espace de travail Ideanote.
Configuration de votre espace de travail Ideanote
Étape 1
- Dans votre espace de travail, accédez au Réglages alors Authentification
- Cliquez Ajouter et a choisi OAuth 2.0
- Sélectionnez votre fournisseur de connexion
Étape 2
- Accédez à Principes de base
- Configuration et personnalisation des paramètres généraux
Étape 3
- Accédez à Copier l'URL de redirection
- Copiez l'URL dans votre presse-papiers. Cette URL devra être copiée dans la configuration OAuth 2.0 de votre application/intégration à l'étape suivante (Étape 4)
Étape 4
Avant nous pouvons procéder avec Étape 4, vérifions rapidement et revoyons les fonctionnalités de haut niveau d'un flux de code d'autorisation OAuth 2.0 :
- Lorsqu'un utilisateur se connecte via l'écran de connexion de votre application de connexion, il est redirigé vers une URL contenant un code d'autorisation en tant que paramètre de requête dans l'URL. Cet endroit doit être l'URL de redirection OAuth d'Ideanote.
- Lorsqu'un utilisateur se connecte via l'écran de connexion de votre application de connexion, il est redirigé vers une URL contenant un code d'autorisation en tant que paramètre de requête dans l'URL. Cet endroit doit être l'URL de redirection OAuth d'Ideanote.
- Comme indiqué dans Étape 3 section, vous devrez copier l'URL de redirection d'Ideanote dans la configuration OAuth 2.0 de votre application/intégration.
- Lorsque vous êtes certain que notre URL de redirection a été ajoutée correctement, cliquez sur Ajouter une configuration et continuons.
C'est parti pour l'étape 4
- Accédez à Ajouter une configuration - C'est ici que vous pouvez coller les informations pertinentes de votre application/intégration OAuth 2, comme décrit dans les étapes précédentes.
- C'est là que Identifiant du client doit être saisi. Il se trouve généralement facilement quelque part dans votre application/intégration OAuth 2.0 et est généralement appelé ID client ou ID d'application.
- C'est là que Secret du client doit être saisi. Cela se trouve généralement facilement quelque part dans votre application/intégration OAuth 2.0 et est généralement appelé Client Secret ou App Secret. Remarque : Si vous hébergez votre propre serveur d'autorisation OAuth 2.0, vous devez vous assurer qu'il est suffisamment aléatoire pour ne pas être deviné. Pour ce faire, vous pouvez utiliser une bibliothèque sécurisée sur le plan cryptographique pour générer une valeur de 256 bits, puis la convertir en une représentation hexadécimale.
- Le Endpoint d'autorisation est celui vers lequel Ideanote enverra vos utilisateurs afin qu'ils puissent s'authentifier auprès de vous avant d'être redirigés vers nous avec un code d'autorisation, si tout se passe bien, en tout cas. Si vous n'hébergez pas votre propre serveur d'autorisation OAuth 2.0, vous pouvez le trouver dans la documentation de votre application/intégration OAuth 2.0.
- Le Token Endpoint est celui auquel Ideanote enverra le code d'autorisation que nous avons reçu du point de terminaison d'autorisation dans le but de l'échanger contre un jeton d'accès. Si nous récupérons un jeton d'accès, cela signifie que nous nous sommes authentifiés avec succès auprès de votre application/intégration au nom de l'utilisateur. Nous utiliserons ce jeton d'accès une seule fois pour récupérer certaines informations pertinentes sur l'utilisateur, telles que son identifiant, son adresse e-mail, son nom, son avatar et éventuellement d'autres informations qui nous ont été fournies par les champs d'application OAuth 2.0 que vous allez saisir
Options supplémentaires
Options de configuration disponibles dans Ajouter une configuration.
- Il s'agit du point de terminaison de l'API qu'Ideanote invoquera avec le jeton d'accès récupéré depuis le point de terminaison du jeton en tant qu'autorisation pour récupérer les informations utilisateur pertinentes. Cela nous permet de récupérer certaines des informations utilisateur obligatoires et facultatives, notamment l'identifiant (ou sous-identifiant) et l'adresse e-mail de l'utilisateur (les deux étant obligatoires), ainsi que des données facultatives telles que le nom, l'avatar, la langue préférée et l'alias préféré. Ce point de terminaison se trouve dans la documentation de l'API de votre application ou intégration OAuth 2.0.
- C'est ici que vous pouvez entrer Périmètre (s) OAuth 2.0 cela devrait être demandé. Vous devez vous assurer que vous entrez au moins une étendue et que celle-ci fournit à Ideanote les deux propriétés de données requises, à savoir email et id (ou sub). Consultez la documentation de votre application/intégration OAuth 2.0 pour en savoir plus sur les champs d'application pris en charge et pour vous assurer qu'Ideanote demandera les champs d'application appropriés pour accéder aux informations utilisateur, idéalement en incluant également le nom et l'avatar.
- Ideanote attend la réponse du point de terminaison d'informations utilisateur que vous avez configuré comme étant un objet JSON. Par défaut, Ideanote tente d'analyser et de mapper ses paires clé-valeur aux informations utilisateur sur la base de suppositions et d'heuristiques. En développant le menu accordéon USER INFO ATTRIBUTES, vous pouvez nous aider en spécifiant le chemin exact dans la réponse JSON User Info que nous devons rechercher pour les attributs d'informations utilisateur individuels.
- Lorsque vous avez rempli tous les champs obligatoires et que vous êtes satisfait de la configuration, vous pouvez cliquer sur le bouton Enregistrer pour enregistrer le fournisseur de connexion OAuth 2.0 sur votre espace de travail Ideanote. À l'avenir, vos utilisateurs verront une nouvelle option de connexion sur la page de connexion. Si la configuration est correcte, cliquez dessus pour accéder à la page de connexion qu'ils utilisent déjà pour se connecter à votre propre système. Une fois authentifiés, ils seront redirigés vers votre espace de travail Ideanote. En fonction des étendues demandées et acceptées, ainsi que du type de données pris en charge par votre application/intégration OAuth, Ideanote connaîtra déjà immédiatement certaines informations sur l'utilisateur, telles que son nom, son avatar, ses paramètres régionaux préférés, etc.
Informations utiles
OAuth 2.0 est un protocole d'autorisation standard bien documenté et populaire dans le secteur.
À ce titre, de nombreuses ressources intéressantes sont disponibles en ligne, notamment des guides et des services détaillés qui facilitent l'intégration de l'authentification basée sur OAuth 2.0 à votre propre API.
Voici quelques ressources que nous recommandons :
Le cadre d'autorisation OAuth 2.0
Quel est le type d'octroi du code d'autorisation OAuth 2.0 ?
Code d'autorisation OAuth 2 : Flow Playground
Si vous avez d'autres questions, n'hésitez pas à nous contacter à l'adresse support@ideanote.io.