Gestion des utilisateurs
L'API Users vous permet de gérer les utilisateurs et de contrôler leur accès aux objets, applications et rapports au sein d'une organisation Stonal. Elle s'adresse aux développeurs qui ont besoin de provisionner des utilisateurs par programmation — créer des comptes, attribuer des permissions et maintenir les enregistrements utilisateur synchronisés avec un annuaire externe.
Comment fonctionne l'accès
L'accès est régi par deux mécanismes complémentaires : les groupes d'utilisateurs, qui regroupent un ensemble de permissions et peuvent être attribués à de nombreux utilisateurs à la fois, et les permissions, qui attachent des profils, des périmètres d'application et des droits sur les objets directement à chaque utilisateur. Les deux sont décrits en détail sur la page Comprendre l'accès.
Le parcours type
- Authentifier les utilisateurs — obtenir et gérer des jetons d'accès pour les appels API au nom d'un utilisateur.
- Comprendre l'accès — comprendre comment les groupes, profils, groupes d'applications et permissions sur les objets interagissent.
- Rechercher les groupes et permissions — interroger les groupes et valeurs de permissions disponibles dans votre organisation.
- Créer ou mettre à jour un utilisateur — provisionner un nouvel utilisateur ou en mettre à jour un existant.
- Supprimer un utilisateur — supprimer un utilisateur et révoquer son accès.
- Resynchroniser les utilisateurs — maintenir les enregistrements utilisateur synchronisés après des modifications en masse.
Prérequis
Avant d'utiliser l'API Users, vous avez besoin de :
- Un jeu valide d'identifiants API (client ID et client secret).
- Un jeton d'accès valide — voir Obtenir un jeton.
- Le code de votre organisation.
Comprendre l'accès
L'accès d'un utilisateur est accordé via exactement deux mécanismes — les groupes d'utilisateurs (userGroupUids) et les permissions (permissions[].uid). Tout le reste — profils, groupes d'applications, objets, groupes de rapports — n'est pas un concept distinct ; il s'agit simplement d'une permission avec un type/subType différent.
Authentifier les utilisateurs
Chez Stonal, nous utilisons un service dédié pour la gestion des identités.
Mettre en place la délégation d'identité
La délégation d'identité permet aux utilisateurs d'un client de s'authentifier via leur propre fournisseur d'identité (OIDC). Il s'agit d'une configuration unique par organisation.
Rechercher les groupes et permissions
Créer, mettre à jour et supprimer des utilisateurs commence toujours par rechercher les UID que vous référencerez. Cette page est la référence unique pour ces recherches.
Créer ou mettre à jour un utilisateur
Créer et mettre à jour un utilisateur sont la même opération et partagent le même corps UpsertUserRequest. POST …/users crée l'utilisateur — ou le met à jour si l'email existe déjà. PUT …/users/ met à jour un utilisateur connu par son UID. Les deux renvoient 200.
Supprimer un utilisateur
Ce guide décrit le processus de suppression d'un utilisateur existant de la plateforme Stonal à l'aide de l'API.
Legacy V1
4 éléments
Resynchroniser les utilisateurs
La resynchronisation compare votre source de vérité à Stonal et applique une création/mise à jour/suppression par utilisateur.