Wat dit API-eindpunt doet

Met de Users API kunt u een lijst krijgen van alle gebruikers in uw Reach 360-account, evenals de gegevens van een enkele gebruiker. Je kunt ook gebruikers uit de training verwijderen.

• Eindpunten
• Gebruikersobject
• Een lijst met gebruikers ophalen
• Specifieke gebruikersgegevens ophalen

Eindpunten

• GET /users- maak een lijst van gebruikers
• GET /users/{userId}- gegevens van een gebruiker opvragen op basis van gebruikersnaam
• DELETE /users/{userId}- gebruiker verwijderen op gebruikersnaam

Gebruikersobject

• id(string) - de unieke identificatiecode van de gebruiker
• email(string) - het e-mailadres van de gebruiker
• groupsUrl(string) - URL om gebruikersgroepen uit de API weer te geven
• reportingGroupsUrl(string) - URL naar een lijst van groepen waarvoor de gebruiker een verslaggever is vanuit de API (let op: alleen ingesteld als de gebruiker een rol speeltreporter)
• managingGroupsUrl(string) - URL naar een lijst van groepen waarvoor de gebruiker manager is vanuit de API (let op: alleen ingesteld als de gebruiker een rol speeltmanager)
• role(string) - de rol van de gebruiker (een vanlearner,author,reporter,manager, ofadmin)
• firstName(string) - de voornaam van de gebruiker
• lastName(string) - de achternaam van de gebruiker
• lastActiveAt(string) - de datum en tijd van de laatste activiteit van de gebruiker in opkomst
• learnerReportUrl(string) - URL om het cursistenrapport van de gebruiker op te halen uit de API
• favoritesUrl(string) - URL om de favorietenlijst van de gebruiker op te halen uit de API
• url(string) - URL om gebruikersgegevens op te halen uit de API
• articulate360User(boolean) - ongeacht of de gebruiker wordt beheerd in Articulate 360

Een lijst met gebruikers ophalen

GET /users

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)
• email(string, optioneel) - indien beschikbaar, stuur alleen gebruikers terug met dit e-mailadres

Voorbeeldreactie

{
„users”: [
{
„id”: „exampleuser-id-1", „email”: "foo@example.com 
 „, „groupsURL”: "https://api.reach360.com/users/example-user-id-1/groups „, 
 „ReportingGroupsURL”: null, 
 „managingGroupsURL”: null, „role”: „cursist”, 
 „voornaam”: „Voornaam voorbeeld 1", 
 „Achternaam”: „Voorbeeld Achternaam 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
},... 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 
 

Specifieke gebruikersgegevens ophalen

GET /users/{userId}

Voorbeeldreactie

{
„id”: „exampleuser-id”, „email”: "example@example.com 
 „, „groupsURL”: "https://api.reach360.com/users/example-user-id-1/groups „, 
 „ReportingGroupsURL”: null, 
 „ManagingGroupsURL”: null, 
 „role”: „cursist”, „firstName”: „Voornaam voorbeeld”, 
 „Achternaam”: „Achternaam voorbeeld”
, „LastActiveAt”: „2021-10-28T 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”: false} 

Endpoint-specifieke foutcodes

• user_not_found- kan de gebruiker niet ophalen omdat de gebruiker niet bestaat

Gebruikers verwijderen op basis van ID

DELETE /users/{userId}

• Alleen cursisten die niet met SSO worden beheerd en die geen Articulate ID hebben, kunnen met de API worden verwijderd.

Voorbeeld van een succesreactie

204 Geen inhoud

Voorbeeld van foutreacties (alleen cursisten kunnen worden verwijderd)

{
„errors”: [
{
„message”: „Je kunt een gebruiker die door 360" wordt beheerd niet verwijderen”, 
 „code”: „validation_failed”}]} 
 
 

Voorbeeld Failure Response (SSO-gebruikers kunnen niet worden verwijderd)

{
„errors”: [
{
„message”: „Geen gebruiker gevonden”, 
 „code”: „not_found”
}]} 
 

Voorbeeld Failure Response (eigenaren kunnen niet worden verwijderd)

{
„errors”: [
{
„message”: „Je kunt een gebruiker die de eigenaar is niet verwijderen”, 
 „code”: „validation_failed”
}]} 
 

Voorbeeld Failure Response (Okta-gebruikers kunnen niet worden verwijderd)

{
„errors”: [
{
„message”: „Geen gebruiker gevonden”, 
 „code”: „not_found”
}]}