Paramètres du compte via Management API

Intégrations

Logto fournit diverses Management API pour gérer les comptes utilisateurs. Vous pouvez utiliser ces API pour construire une page de paramètres de compte en libre-service pour les utilisateurs finaux.

Architecture

1. Utilisateur : Utilisateur final authentifié qui doit accéder et gérer les paramètres de son compte.
2. Application cliente : Votre application cliente qui sert la page des paramètres de compte à l'utilisateur.
3. Application côté serveur : Application côté serveur qui fournit l'API des paramètres de compte au client. Interagit avec la Management API de Logto.
4. Logto : Logto en tant que service d'authentification et d'autorisation. Fournit la Management API pour gérer les comptes utilisateurs.

Diagramme de séquence

1. L'utilisateur accède à l'application cliente.
2. L'application cliente envoie la requête d’authentification à Logto et redirige l'utilisateur vers la page de connexion Logto.
3. L'utilisateur se connecte à Logto.
4. L'utilisateur authentifié est redirigé vers l'application cliente avec le code d'autorisation.
5. L'application cliente demande le jeton d’accès à Logto pour accéder à l’API des paramètres de compte auto-hébergée.
6. Logto accorde le jeton d’accès à l'application cliente.
7. L'application cliente envoie la requête des paramètres de compte à l'application côté serveur avec le jeton d’accès utilisateur.
8. L'application côté serveur vérifie l'identité et la permission du demandeur à partir du jeton d’accès utilisateur. Puis demande un jeton d’accès Management API à Logto.
9. Logto accorde le jeton d’accès Management API à l'application côté serveur.
10. L'application côté serveur demande les données utilisateur à Logto en utilisant le jeton d’accès Management API.
11. Logto vérifie l'identité du serveur et la permission Management API et retourne les données utilisateur.
12. L'application côté serveur traite les données utilisateur selon la permission du demandeur et retourne les détails du compte utilisateur à l'application cliente.

Intégrer Management API à l'application côté serveur

Consultez la section Management API pour apprendre à intégrer les Management API avec les applications côté serveur.

APIs de gestion des utilisateurs

Schéma des données utilisateur

Consultez la section données utilisateur et données personnalisées pour en savoir plus sur le schéma utilisateur dans Logto.

APIs de gestion du profil utilisateur et des identifiants

Le profil et les identifiants d'un utilisateur sont essentiels pour la gestion des utilisateurs. Vous pouvez utiliser les APIs suivantes pour gérer les profils et identifiants utilisateur.

méthode	chemin	description
GET	/api/users/{userId}	Obtenir les détails utilisateur par ID.
PATCH	/api/users/{userId}	Mettre à jour les détails utilisateur.
PATCH	/api/users/{userId}/profile	Mettre à jour les champs du profil utilisateur par ID.
GET	/api/users/{userId}/custom-data	Obtenir les données personnalisées utilisateur par ID.
PATCH	/api/users/{userId}/custom-data	Mettre à jour les données personnalisées utilisateur par ID.
PATCH	/api/users/{userId}/is-suspended	Mettre à jour le statut de suspension utilisateur par ID.

Vérification de l’e-mail et du numéro de téléphone

Dans le système Logto, les adresses e-mail et les numéros de téléphone peuvent servir d'identifiants utilisateur, rendant leur vérification essentielle. Pour cela, nous fournissons un ensemble d’APIs de code de vérification pour aider à vérifier l’e-mail ou le numéro de téléphone fourni.

remarque:

Assurez-vous de vérifier l’e-mail ou le numéro de téléphone avant de mettre à jour le profil utilisateur avec un nouvel e-mail ou numéro de téléphone.

méthode	chemin	description
POST	/api/verifications/verification-code	Envoyer un code de vérification par e-mail ou SMS.
POST	/api/verifications/verification-code/verify	Vérifier l’e-mail ou le numéro de téléphone par code de vérification.

Gestion du mot de passe utilisateur

méthode	chemin	description
POST	/api/users/{userId}/password/verify	Vérifier le mot de passe actuel par ID.
PATCH	/api/users/{userId}/password	Mettre à jour le mot de passe utilisateur par ID.
GET	/api/users/{userId}/has-password	Vérifier si l'utilisateur a un mot de passe par ID.

remarque:

Assurez-vous de vérifier le mot de passe actuel de l'utilisateur avant de le mettre à jour.

Gestion des identités sociales utilisateur

méthode	chemin	description
GET	/api/users/{userId}	Obtenir les détails utilisateur par ID. Les identités sociales se trouvent dans le champ identities.
POST	/api/users/{userId}/identities	Lier une identité sociale authentifiée à l'utilisateur par ID.
DELETE	/api/users/{userId}/identities	Délier une identité sociale de l'utilisateur par ID.
PUT	/api/users/{userId}/identities	Mettre à jour directement une identité sociale liée à l'utilisateur par ID.
POST	/api/connectors/{connectorId}/authorization-uri	Obtenir l’URI d’autorisation pour un fournisseur d’identité sociale. Utilisez cette URI pour initier une nouvelle connexion sociale.

1. L'utilisateur accède à l'application cliente et demande à lier une identité sociale.
2. L'application cliente envoie une demande au serveur pour lier une identité sociale.
3. Le serveur envoie une demande à Logto pour obtenir l’URI d’autorisation du fournisseur d’identité sociale. Vous devez fournir votre propre paramètre state et redirect_uri dans la requête. Assurez-vous d’enregistrer le redirect_uri auprès du fournisseur d’identité sociale.
4. Logto retourne l’URI d’autorisation au serveur.
5. Le serveur retourne l’URI d’autorisation à l’application cliente.
6. L’application cliente redirige l’utilisateur vers l’URI d’autorisation de l’IdP.
7. L’utilisateur se connecte à l’IdP.
8. L’IdP redirige l’utilisateur vers l’application cliente via le redirect_uri avec le code d’autorisation.
9. L’application cliente valide le state et transmet la réponse d’autorisation IdP au serveur.
10. Le serveur envoie une demande à Logto pour lier l’identité sociale à l’utilisateur.
11. Logto récupère les informations utilisateur auprès de l’IdP à l’aide du code d’autorisation.
12. L’IdP retourne les informations utilisateur à Logto et Logto lie l’identité sociale à l’utilisateur.

remarque:

Il existe quelques limitations à prendre en compte lors de la liaison de nouvelles identités sociales à un utilisateur :

• La Management API n’a pas de contexte de session, tout connecteur social nécessitant une session active pour maintenir l’état d’authentification sociale ne peut pas être lié via la Management API. Les connecteurs non pris en charge incluent apple, OIDC standard et connecteur OAuth 2.0 standard.
• Pour la même raison, Logto ne peut pas vérifier le paramètre state dans la réponse d’autorisation. Assurez-vous de stocker le paramètre state dans votre application cliente et de le valider lors de la réception de la réponse d’autorisation.
• Vous devez enregistrer le redirect_uri auprès du fournisseur d’identité sociale à l’avance. Sinon, l’IdP social ne redirigera pas l’utilisateur vers votre application cliente. Votre IdP social doit accepter plus d’un redirect_uri de rappel, un pour la connexion utilisateur, un pour votre propre page de liaison de profil.

Gestion des identités d’entreprise utilisateur

méthode	chemin	description
GET	/api/users/{userId}?includeSsoIdentities=true	Obtenir les détails utilisateur par ID. Les identités d’entreprise se trouvent dans le champ ssoIdentities. Ajoutez le paramètre de requête includeSsoIdentities=true à l’API pour les inclure.

Actuellement, la Management API ne prend pas en charge la liaison ou la suppression des identités d’entreprise à un utilisateur. Vous pouvez seulement afficher les identités d’entreprise liées à un utilisateur.

Jeton d’accès personnel

méthode	chemin	description
GET	/api/users/{userId}/personal-access-tokens	Obtenir tous les jetons d’accès personnels pour l’utilisateur.
POST	/api/users/{userId}/personal-access-tokens	Ajouter un nouveau jeton d’accès personnel pour l’utilisateur.
DELETE	/api/users/{userId}/personal-access-tokens/{name}	Supprimer un jeton pour l’utilisateur par nom.
PATCH	/api/users/{userId\s}/personal-access-tokens/{name}	Mettre à jour un jeton pour l’utilisateur par nom.

Les jetons d’accès personnels offrent un moyen sécurisé pour les utilisateurs d’accorder un jeton d’accès (Access token) sans utiliser leurs identifiants et sans connexion interactive. En savoir plus sur l’utilisation des jetons d’accès personnels.

Gestion des paramètres MFA utilisateur

méthode	chemin	description
GET	/api/users/{userId}/mfa-verifications	Obtenir les paramètres MFA utilisateur par ID.
POST	/api/users/{userId}/mfa-verifications	Configurer une vérification MFA utilisateur par ID.
DELETE	/api/users/{userId}/mfa-verifications/{verificationId}	Supprimer une vérification MFA utilisateur par ID.

Suppression du compte utilisateur

méthode	chemin	description
DELETE	/api/users/{userId}	Supprimer un utilisateur par ID.