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 identifiants.

Largement adopté par les grandes entreprises technologiques et intégré dans 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 de manière transparente 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, où les utilisateurs peuvent facilement accorder l'accès à leurs données sans compromettre leurs identifiants de connexion.

1. Dans votre espace de travail, naviguez vers les Paramètres, puis Authentification
2. Cliquez sur Ajouter et choisissez OAuth 2.0
3. Parcourez la boîte de dialogue de configuration qui apparaît

‍

‍

S'authentifier avec OAuth

Guide d'implémentation

OAuth 2.0 est le protocole standard de l'industrie pour l'autorisation. OAuth 2.0 se concentre sur la simplicité pour les développeurs clients tout en fournissant des flux d'autorisation spécifiques pour des applications telles qu'Ideanote.

Ideanote prend en charge un flux de code d'autorisation basé sur OAuth 2.0. C'est le plus courant des types d'octroi OAuth 2.0, et en relation avec Ideanote, le flux se déroule grosso modo comme suit :

1. Ideanote envoie votre utilisateur vers un écran de connexion que vous contrôlez (ou avec lequel vous vous intégrez), et que l'utilisateur connaît déjà.
2. L'utilisateur entre ses identifiants et tente de s'authentifier.
3. Si les identifiants sont valides, l'utilisateur sera redirigé vers Ideanote avec un code d'autorisation comme paramètre de requête dans l'URL.
4. Ideanote échange ensuite ce code d'autorisation contre un jeton d'accès en communiquant avec votre API.
5. En utilisant ce jeton d'accès comme autorisation, Ideanote récupère des informations utilisateur de votre API, telles que l'adresse e-mail, l'identifiant (ou sub), l'avatar, la locale préférée et le nom.

Si vous souhaitez approfondir ce sujet, voici une excellente ressource sur le sujet.

‍

Avantages

• Un moyen facile d'assurer une authentification forte.
• Vos utilisateurs se connectent via un système auquel ils font déjà confiance, et ils ne partagent jamais leurs identifiants directement avec Ideanote.
• Étant donné que vos utilisateurs s'authentifient directement via votre système (ou un système que vous contrôlez), vous gardez un contrôle total sur l'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 avec des milliers de solutions logicielles.

‍

Prérequis

Vous devrez soit :

1. Utiliser déjà un fournisseur de connexion pour votre propre système qui prend en charge OAuth 2.0, comme Okta, Facebook, Google, Github, et bien d'autres. Ou,
2. Exécuter vous-même un serveur d'authentification OAuth 2 conforme à la spécification OAuth 2.0

‍

Note Importante :

Pour commencer l'authentification basée sur OAuth 2.0, vous devrez 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.

Vous devrez copier quelques éléments de là vers la configuration de votre espace de travail Ideanote, et vice versa. Nous aborderons les détails dans un instant.

Pour votre commodité, nous avons préparé une petite liste de liens directs vers la documentation pertinente pour certains fournisseurs de connexion populaires prenant en charge OAuth 2.0 ci-dessous :

Google

Slack

Discord

Dropbox

Github

Facebook

Le fonctionnement typique est une variation du suivant : Vous créez une application ou une intégration OAuth. Là, vous verrez un ID Client et un Secret Client, ainsi qu'une liste des portées OAuth qu'il prend en charge. Vous pourrez également saisir une ou plusieurs URL de redirection. Enfin, vous devriez voir une liste de points de terminaison d'API pertinents tels que le Point de Terminaison d'Autorisation et le Point de Terminaison de Jeton.

Ces images sont des exemples d'intégrations OAuth 2.0. La première est de Github, et la seconde 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 êtes maintenant prêt à passer à sa configuration sur votre espace de travail Ideanote.

Configuration de votre espace de travail Ideanote

‍

Étape 1

1. Dans votre espace de travail, naviguez vers les Paramètres, puis Authentification
2. Cliquez sur Ajouter et choisissez OAuth 2.0
3. Sélectionnez votre fournisseur de connexion

‍

Étape 2

1. Allez à Bases
2. Configurez et personnalisez les paramètres généraux

‍

Étape 3

1. Allez à Copier l'URL de Redirection
2. 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 de pouvoir passer à l'Étape 4, faisons une vérification rapide et revoyons la fonctionnalité générale d'un flux de code d'autorisation OAuth 2.0 :

1. Lorsqu'un utilisateur se connecte via l'écran de connexion de votre application de connexion, il sera redirigé vers une URL avec un code d'autorisation comme paramètre de requête dans l'URL. Cet endroit doit être l'URL de redirection OAuth d'Ideanote.
2. Lorsqu'un utilisateur se connecte via l'écran de connexion de votre application de connexion, il sera redirigé vers une URL avec un code d'autorisation comme paramètre de requête dans l'URL. Cet endroit doit être l'URL de redirection OAuth d'Ideanote.
3. Comme mentionné dans la section Étape 3, vous devrez copier l'URL de redirection d'Ideanote dans la configuration OAuth 2.0 de votre application/intégration.
4. Lorsque vous êtes sûr que notre URL de redirection a été ajoutée correctement, veuillez cliquer sur Ajouter la configuration et poursuivons.

‍

C'est parti pour l'Étape 4

‍

1. Allez à Ajouter la 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.
2. C'est ici que l'ID Client doit être saisi. Il est généralement facile à trouver dans votre application/intégration OAuth 2.0 et est généralement appelé ID Client ou ID App.
3. C'est ici que le Secret Client doit être saisi. Il est généralement facile à trouver dans votre application/intégration OAuth 2.0 et est généralement appelé Secret Client ou Secret App. 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 devinable. Une façon de le faire est d'utiliser une bibliothèque cryptographiquement sécurisée pour générer une valeur de 256 bits, puis de la convertir en une représentation hexadécimale.
4. Le Point de Terminaison 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, bien sûr. Si vous n'hébergez pas votre propre serveur d'autorisation OAuth 2.0, vous pourrez le trouver dans la documentation de votre application/intégration OAuth 2.0.
5. Le Point de Terminaison de Jeton est celui vers lequel Ideanote enverra le code d'autorisation que nous avons reçu du point de terminaison d'autorisation dans l'intention de l'échanger contre un jeton d'accès. Si nous recevons un jeton d'accès en retour, 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 des informations utilisateur pertinentes, telles que leur identifiant, leur adresse e-mail, leur nom, leur avatar et potentiellement d'autres informations qui nous sont accordées par les portées OAuth 2.0 que vous saisirez.

‍

Options Supplémentaires

Options de configuration disponibles dans Ajouter la configuration.

1. Il s'agit du point de terminaison d'API qu'Ideanote invoquera avec le jeton d'accès récupéré du point de terminaison de jeton comme autorisation pour récupérer les informations utilisateur pertinentes. Cela nous permet de récupérer certaines informations utilisateur requises, ainsi que facultatives, y compris l'identifiant (ou sub) et l'adresse e-mail de l'utilisateur (tous deux requis), ainsi que des données facultatives telles que le nom, l'avatar, la locale préférée et l'alias préféré. Ce point de terminaison se trouve dans la documentation API de votre application ou intégration OAuth 2.0.
2. C'est ici que vous pouvez saisir la ou les portée(s) OAuth 2.0 qui doivent être demandées. Vous devez vous assurer de saisir au moins une portée, et que cette portée fournit à Ideanote les deux propriétés de données requises, qui sont l'e-mail et l'identifiant (ou sub). Veuillez consulter la documentation de votre application/intégration OAuth 2.0 pour en savoir plus sur les portées qu'ils prennent en charge et pour vous assurer qu'Ideanote demandera les portées correctes pour obtenir l'accès aux informations utilisateur, incluant idéalement le nom et l'avatar.
3. Ideanote s'attend à ce que la réponse du point de terminaison d'informations utilisateur que vous avez configuré soit un objet JSON. Par défaut, Ideanote tentera d'analyser et de mapper ses paires clé-valeur aux informations utilisateur basées sur des suppositions et des heuristiques. En développant le menu accordéon ATTRIBUTS D'INFORMATIONS UTILISATEUR, vous pouvez nous aider en spécifiant le chemin exact dans la réponse JSON d'informations utilisateur que nous devrions rechercher pour les attributs d'informations utilisateur individuels.
4. Lorsque vous avez rempli tous les champs requis et êtes satisfait de la configuration, vous pouvez cliquer sur le bouton Enregistrer pour sauvegarder 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 elle est configurée correctement, cliquer dessus les mènera à la page de connexion qu'ils utilisent déjà pour se connecter à votre propre système, et après une authentification réussie, ils seront redirigés vers votre espace de travail Ideanote. En fonction des portées 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à certains détails sur l'utilisateur immédiatement, tels que son nom, son avatar, sa locale préférée, et ainsi de suite.

‍

Informations Utiles

OAuth 2.0 est un protocole standard de l'industrie bien documenté et populaire pour l'autorisation.

En tant que tel, de nombreuses excellentes ressources sont disponibles en ligne, y compris des guides détaillés et des services qui facilitent l'intégration de l'authentification basée sur OAuth 2.0 avec votre propre API.

Voici quelques ressources que nous recommandons :

Le Cadre d'Autorisation OAuth 2.0

Qu'est-ce que le Type d'Octroi de Code d'Autorisation OAuth 2.0 ?

Terrain de Jeu du Flux de Code d'Autorisation OAuth 2

OAuth 2 Simplifié

Si vous avez d'autres questions, n'hésitez pas à nous contacter à support@ideanote.io.

‍