Cosa fa questo endpoint API

Con l'API Users puoi ottenere un elenco di tutti gli utenti del tuo account Reach 360 e i dettagli di un singolo utente. Puoi anche eliminare gli utenti dalla formazione.

• Endpoint
• Oggetto utente
• Recupero di un elenco di utenti
• Recupero di dettagli utente specifici

Endpoint

• GET /users- elenca gli utenti
• GET /users/{userId}- ottieni i dettagli di un utente per ID utente
• DELETE /users/{userId}- elimina utente per ID utente

Oggetto utente

• id(stringa): l'identificatore univoco dell'utente
• email(string) - l'indirizzo email dell'utente
• groupsUrl(string) - URL per elencare i gruppi di utenti dall'API
• reportingGroupsUrl(string) - URL per elencare i gruppi di cui l'utente è un reporter dell'API (nota: impostato solo quando l'utente ha un ruolo direporter)
• managingGroupsUrl(stringa) - URL per elencare i gruppi di cui l'utente è gestore tramite l'API (nota: impostato solo quando l'utente ha un ruolo dimanager)
• role(stringa) - il ruolo dell'utente (uno tra learnerauthor,reporter,manager, oadmin)
• firstName(stringa): il nome dell'utente
• lastName(string) - il cognome dell'utente
• lastActiveAt(stringa) - la data e l'ora dell'ultima attività dell'utente in aumento
• learnerReportUrl(string) - URL per recuperare il rapporto sullo studente dell'utente dall'API
• favoritesUrl(stringa) - URL per recuperare l'elenco dei preferiti dell'utente dall'API
• url(stringa) - URL per recuperare i dettagli dell'utente dall'API
• articulate360User(boolean) - indipendentemente dal fatto che l'utente sia gestito o meno in Articulate 360

Recupero di un elenco di utenti

GET /users

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 100 (il valore predefinito è 50)
• email(stringa, opzionale): se fornito, restituisce solo gli utenti con questo indirizzo email

Esempio di risposta

{
«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»: «learner», «firstName»: «Nome di esempio 1", «cognome»: «Esempio di cognome 1", «cognome», «lastActiveAT»: 
 «28/10/2021 T 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»: falso
},... 
], 
 «nextUrl»: "https://url-for-next-page-of-results"} 
 

Recupero di dettagli utente specifici

GET /users/{userId}

Esempio di risposta

{
«id»: «example-user-id», «email»: "example@example.com 
 «, «groupSURL»: "https://api.reach360.com/users/example-user-id-1/groups «, 
 «reportingGroupSURL»: null, 
 «managingGroupSURL»: null, 
 «role»: «learner», «firstName»: «Nome di esempio», 
 «lastName»: «Cognome di esempio»
, «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»: falso
}

Codici di errore specifici dell'endpoint

• user_not_found- impossibile recuperare l'utente perché l'utente non esiste

Eliminazione degli utenti tramite ID

DELETE /users/{userId}

• Solo gli allievi che non sono gestiti con SSO e che non dispongono di un Articulate ID possono essere eliminati con l'API.

Esempio di risposta di successo

204 Nessun contenuto

Esempio di risposte agli errori (solo gli allievi possono essere eliminati)

{
«errors»: [
{
«message»: «Non puoi eliminare un utente gestito da 360", 
 «code»: «validation_failed»}]} 
 
 

Esempio di risposta ai guasti (gli utenti SSO non possono essere eliminati)

{
«errors»: [
{
«message»: «Nessun utente trovato», 
 «code»: «not_found»
}]} 
 

Esempio di risposta in caso di errore (i proprietari non possono essere eliminati)

{
«errors»: [
{
«message»: «Non puoi eliminare un utente che è il proprietario», 
 «code»: «validation_failed»
}]} 
 

Esempio di risposta agli errori (gli utenti Okta non possono essere eliminati)

{
«errors»: [
{
«message»: «Nessun utente trovato», 
 «code»: «not_found»
}]}