Explorer le plein potentiel de l'API de gestion Logto
Dans cet article, nous réinsisterons sur la définition de l'API de gestion Logto, expliquerons comment elle fonctionne, et montrerons des scénarios typiques pour améliorer votre productivité et découvrir davantage de cas d'utilisation.
Product & Design
En tant que service d'infrastructure, nous nous efforçons de rendre l'utilisation de notre API de gestion Logto plus facile et rapide. Nous avons récemment mis à jour nos guides et tutoriels. Dans cet article, nous réinsisterons sur la définition de l'API de gestion Logto, expliquerons comment elle fonctionne, et montrerons des scénarios typiques pour améliorer votre productivité et découvrir davantage de cas d'utilisation.
Qu'est-ce que l'API de gestion Logto
L'API de gestion Logto est un ensemble puissant d'APIs pré-construites qui permet aux développeurs de personnaliser pleinement leur implémentation afin de répondre à leurs besoins produits et technologies.
Elle est répertoriée dans la liste de ressources d'API et ne peut être supprimée ni modifiée. Tout ce que vous pouvez faire dans la console d'administration Logto peut également être fait avec l'API de gestion Logto.
Son identifiant est dans le format de https://[tenant-id].logto.app/api
Elle inclut par défaut toutes les permissions. À mesure que Logto évolue, nous continuerons à rendre les permissions plus granulaires.
Avec l'API de gestion Logto, vous pouvez accéder aux services backend robustes de Logto, qui sont hautement évolutifs et peuvent être utilisés dans une multitude de scénarios. Pour en savoir plus sur les APIs disponibles, veuillez visiter les références d'API Logto.
Scénarios typiques d'utilisation de l'API de gestion
Nos développeurs ont implémenté de nombreuses fonctionnalités supplémentaires en utilisant notre API de gestion. Nous croyons que notre API est hautement évolutive et peut répondre à un large éventail de vos besoins. Voici quelques exemples de scénarios qui ne sont pas possibles avec la console d'administration Logto, mais qui peuvent être réalisés via l'API de gestion.
Implémenter un profil utilisateur avec votre UI personnalisée
Logto ne propose actuellement pas de solution UI pré-construite pour les profils utilisateurs. Nous reconnaissons que les profils utilisateurs sont étroitement liés aux attributs commerciaux et de produits. Pendant que nous travaillons à déterminer la meilleure approche, nous vous suggérons d'utiliser nos APIs pour créer votre propre solution. Par exemple, vous pouvez utiliser notre API d'interaction, l'API de profil et l'API de code de vérification pour développer une solution personnalisée qui répond à vos besoins. Nous avons préparé une page dédiée Profil Utilisateur pour les tutoriels et guides.
Un exemple intéressant est que la fonction de profil utilisateur de Logto Cloud est construite en utilisant l'API de gestion Logto.
Implémenter la gestion des organisations avec votre UI personnalisée
Si vous utilisez la fonctionnalité d'organisation pour créer votre application multi-tenant, vous pourriez avoir besoin de l'API de gestion Logto pour des tâches comme les invitations d'organisation et la gestion des membres.
De même, la fonction d'invitation et de collaboration de Logto Cloud est également construite en utilisant l'API de gestion Logto.
Pour étendre ce cas, pour votre produit SaaS, où vous avez à la fois des administrateurs et des membres dans le tenant, l'API de gestion Logto peut vous aider à créer un portail administrateur personnalisé adapté à vos besoins commerciaux. Consultez ceci pour plus de détails.
Recherche utilisateur avancée
La console d'administration Logto prend en charge les fonctions de recherche et de filtrage de base. Si vous avez besoin de davantage d'options avancées pour adapter votre service de gestion utilisateurs à vos besoins commerciaux, vous pouvez utiliser l'API de gestion Logto. Elle prend en charge des options de recherche avancées, telles que :
- Recherche floue
- Correspondance exacte
- Sensibilité à la casse
- Spécification des champs
Consultez nos tutoriels et guides sur la Recherche Avancée d'Utilisateur.
Utiliser les journaux de Logto pour construire vos propres services
Le journal d'audit de Logto vous permet de surveiller facilement l'activité des utilisateurs et les événements. Il fournit une solide base pour divers scénarios commerciaux de gestion des utilisateurs et de vérification de l'intégrité.
En utilisant l'API de gestion, vous pouvez accéder aux données des journaux d'audit en temps réel. Cela vous permet de concevoir votre propre modèle de schéma et tableau de bord en utilisant les données de journaux obtenues de Logto.
Migrer et importer des utilisateurs vers Logto
L'utilisation de l'API de gestion peut vous aider facilement à importer des données utilisateurs, surtout si vous souhaitez faire une migration vers Logto.
Après avoir préparé les données des utilisateurs et mis en place le hachage des mots de passe et le schéma utilisateur, configurez la connexion API de gestion et nous appellerons l'API pour créer un utilisateur pour importer les données des utilisateurs. Pour en savoir plus sur la migration, consultez ce document.
Comment accéder à l'API de gestion Logto
Créer une application M2M
Sélectionnez le type d'application M2M et commencez le processus de création. Après la création, vous serez dirigé vers un module où vous pourrez attribuer un rôle machine-à-machine.
Après avoir fourni un nom et une description, vous verrez un module qui vous demande d'attribuer un rôle. Ce module inclut tous les rôles M2M, les rôles indiqués par une icône Logto signifient que ces rôles incluent les permissions de l'API de gestion Logto.
L'attribution de rôles M2M inclut les permissions de l'API de gestion Logto pour votre application M2M.
Pourquoi utiliser la communication machine-à-machine et attribuer des rôles machine-à-machine ?
Pourquoi Logto permet-il la communication M2M (Machine-to-Machine) pour appeler l'API de gestion Logto au lieu d'utiliser des clés API ?
Logto gère l'identité des clients et suit strictement les standards ouverts comme OAuth 2.0 et OpenID Connect. Les tokens M2M offrent des interactions serveur-à-serveur sécurisées avec des scopes spécifiques, offrant une meilleure sécurité que les clés API statiques. Contrairement aux clés API, qui n'expirent pas et posent un risque plus élevé en cas de compromission, les tokens M2M ont des durées d'expiration définies, limitant ainsi la fenêtre de temps pour une éventuelle mauvaise utilisation.
Chez Logto, nous utilisons le contrôle d'accès basé sur les rôles (RBAC) pour protéger et gérer l'accès à l'API de gestion Logto. Ce diagramme entité montre comment cela fonctionne.
La relation entre permissions, ressources API, rôles et application machine-à-machine.
Obtenir un jeton d'accès
Bases concernant la demande d'un jeton d'accès
L'application M2M fait une requête POST au point d'extrémité du token pour obtenir un jeton d'accès en ajoutant les paramètres suivants en utilisant le format application/x-www-form-urlencoded dans le corps de l'entité HTTP :
- grant_type: doit être défini sur
client_credentials - resource: l'indicateur de ressource que vous souhaitez accéder
- scope: Le périmètre de la demande d'accès
Et vous devez également inclure vos identifiants M2M pour que le point d'extrémité du token authentifie votre application M2M. Cela est obtenu en ajoutant un header Authorization en utilisant l'authentification Basique, où le nom d'utilisateur est l'ID de l'application et le mot de passe est le secret de l'application.
Vous pouvez trouver l'ID de l'application et le secret de l'application dans la page des détails de votre application M2M :
Un exemple de requête de jeton d'accès pour l'API de gestion Logto est :
Obtenir un jeton d'accès pour l'API de gestion Logto
Logto fournit une ressource incorporée « API de gestion Logto », c'est une ressource en lecture seule avec la permission all pour accéder à l'API de gestion Logto, vous pouvez la voir dans votre liste de ressources API.
L'indicateur API de cette ressource prend la forme de https://{YOUR_TENANT_ID}.logto.app/api, et il s'agit de la valeur de ressource à utiliser dans le corps de la requête du jeton d'accès.
Avant d'accéder à l'API de gestion Logto, assurez-vous que votre application M2M a été attribuée avec des rôles M2M qui incluent la permission all de cette ressource incorporée « API de gestion Logto ».
Maintenant, composez tout ce que nous avons et envoyez la requête :
Réponse du jeton
Un corps de réponse réussi serait le suivant :
Accéder à l'API de gestion Logto en utilisant le jeton d'accès https://docs.logto.io/quick-starts/m2m/#access-resource-using-access-token
Vous remarquerez peut-être que la réponse du jeton contient un champ token_type, qui est fixé à Bearer. Vous devez donc placer le jeton d'accès dans le champ Authorization des en-têtes HTTP avec le format Bearer (Bearer YOUR_TOKEN).
Maintenant, vous pouvez accéder à l'API de gestion Logto en faisant une requête au point de terminaison de l'API de gestion de Logto https://[your-tenant-id].logto.app/api, pour obtenir toutes les applications dans Logto
Ressources connexes
Voici quelques ressources connexes qui approfondissent nos précédentes idées et stratégies pour utiliser l'API de gestion Logto. Ces matériaux couvrent divers aspects, y compris les meilleures pratiques, les conseils d'implémentation, et les cas d'utilisation, afin de vous aider à tirer le meilleur parti de l'API de gestion Logto pour vos projets.