Ce que fait ce point de terminaison d'API

Avec l'API Users, vous pouvez obtenir une liste de tous les utilisateurs de votre compte Reach 360 ainsi que les détails d'un seul utilisateur. Vous pouvez également supprimer des utilisateurs de la formation.

• Points de terminaison
• Objet utilisateur
• Récupération d'une liste d'utilisateurs
• Récupération de détails spécifiques à un utilisateur

Points de terminaison

• GET /users- liste des utilisateurs
• GET /users/{userId}- obtenir les détails d'un utilisateur par nom d'utilisateur
• DELETE /users/{userId}- supprimer un utilisateur par nom d'utilisateur

Objet utilisateur

• id(chaîne) - l'identifiant unique de l'utilisateur
• email(string) : adresse e-mail de l'utilisateur
• groupsUrl(string) - URL pour répertorier les groupes d'utilisateurs à partir de l'API
• reportingGroupsUrl(string) - URL permettant de répertorier les groupes pour lesquels l'utilisateur est rapporteur depuis l'API (remarque : définie uniquement lorsque l'utilisateur a un rôle dereporter)
• managingGroupsUrl(string) - URL permettant de répertorier les groupes dont l'utilisateur est le gestionnaire à partir de l'API (remarque : défini uniquement lorsque l'utilisateur a un rôle demanager)
• role(chaîne) - le rôle de l'utilisateur (l'un des rôles suivants : learner authorreporter,manager,, ouadmin)
• firstName(chaîne) - le prénom de l'utilisateur
• lastName(chaîne) - le nom de famille de l'utilisateur
• lastActiveAt(chaîne) : date et heure de la dernière activité de l'utilisateur lors de la hausse
• learnerReportUrl(string) - URL pour récupérer le rapport d'apprenant de l'utilisateur depuis l'API
• favoritesUrl(string) - URL pour récupérer la liste des favoris de l'utilisateur depuis l'API
• url(string) - URL pour récupérer les informations de l'utilisateur depuis l'API
• articulate360User(booléen) : indique si l'utilisateur est géré ou non dans Articulate 360

Récupération d'une liste d'utilisateurs

GET /users

Paramètres de demande (chaîne de requête)

• limit(entier, facultatif) - le nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)
• email(chaîne, facultatif) - si elle est fournie, ne renvoie que les utilisateurs avec cette adresse e-mail

Exemple de réponse

{
« users » : [
{« id » : 
 « example-user-id-1", « email » : "foo@example.com 
 «, « groupsURL » : "https://api.reach360.com/users/example-user-id-1/groups «, « reportingGroupsURL » : null, 
 « managingGroupsURL » : null, « role » : 
 « apprenant », « FirstName » : « Exemple de prénom 1 », 
 « LastName » : « Exemple de nom de famille 1 », 
 « Example Last Name » : « Example Last Name 1"
, « LastActiveat » : « 2021-10-28T 20:39:52.659 Z »
, « LearnerReportURL » : "https://api.reach360.com/reports/learners/example-user-id-1 «
, « FavoritesURL » : » 
 
 https://api.reach360.com/users/example-user-id-1/favorites «, 
 « url » : "https://api.reach360.com/users/example-user-id-1" 
 « Articulate360User » : false},... 
 
], 
 « URL suivante » : "https://url-for-next-page-of-results"} 
 

Récupération de détails spécifiques à un utilisateur

GET /users/{userId}

Exemple de réponse

{
« id » : « example-user-id », « email » : "example@example.com 
 «, « groupsURL » : "https://api.reach360.com/users/example-user-id-1/groups «, 
 « reportingGroupsURL » : null, 
 « managingGroupsURL » : null, « role » : « apprenant », 
 « FirstName » : « Exemple de prénom », 
 « LastName » : « Exemple de nom de famille »
, « LastActiveat » : « 2021-10-28T 20:39:52.659 Z »
, « LearnerReportURL » : "https://api.reach360.com/reports/learners/example-user-id «
, « FavoritesURL » : "https://api.reach360.com/users/example-user-id/favorites «, 
 
 
« url » : "https://api.reach360.com/users/example-user-id" 
 « Articulate360User » : faux} 

Codes d'erreur spécifiques au point de terminaison

• user_not_found- Impossible de récupérer l'utilisateur car l'utilisateur n'existe pas

Supprimer des utilisateurs par identifiant

DELETE /users/{userId}

• Seuls les apprenants qui ne sont pas gérés par SSO et qui ne possèdent pas d'Articulate ID peuvent être supprimés avec l'API.

Exemple de réponse positive

204 Pas de contenu

Exemples de réponses en cas d'échec (seuls les apprenants peuvent être supprimés)

{
« errors » : [
{
« message » : « Vous ne pouvez pas supprimer un utilisateur géré par 360 », 
 « code » : « validation_failed »}]} 
 
 

Exemple de réponse en cas d'échec (les utilisateurs SSO ne peuvent pas être supprimés)

{
« errors » : [
{
« message » : « Aucun utilisateur trouvé », 
 « code » : « not_found »
}]} 
 

Exemple de réponse en cas d'échec (les propriétaires ne peuvent pas être supprimés)

{
« errors » : [
{
« message » : « Vous ne pouvez pas supprimer un utilisateur qui en est le propriétaire », 
 « code » : « validation_failed »
}]} 
 

Exemple de réponse en cas d'échec (les utilisateurs d'Okta ne peuvent pas être supprimés)

{
« errors » : [
{
« message » : « Aucun utilisateur trouvé », 
 « code » : « not_found »
}]}