Browse Articles

Browse Articles

Reach 360: API de usuarios

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este punto final de API

Con la API de usuarios, puede obtener una lista de todos los usuarios de su cuenta de Reach 360, así como los detalles de un solo usuario. También puedes eliminar usuarios de la formación.

Puntos finales

  • GET /users- lista de usuarios
  • GET /users/{userId}- obtener los detalles de un usuario por seudónimo
  • DELETE /users/{userId}- eliminar usuario por seudónimo

Objeto de usuario

  • id(cadena): el identificador único del usuario
  • email(cadena): la dirección de correo electrónico del usuario
  • groupsUrl(cadena): URL para enumerar los grupos de usuarios de la API
  • role(cadena): el rol del usuario (uno de learnerauthor,reporter, oadmin)
  • firstName(cadena): nombre del usuario
  • lastName(cadena): apellido del usuario
  • lastActiveAt(cadena): fecha y hora de la última actividad del usuario en Rise
  • learnerReportUrl(string): URL para obtener el informe de aprendizaje del usuario desde la API
  • favoritesUrl(string): URL para obtener la lista de favoritos del usuario desde la API
  • url(string): URL para obtener los detalles del usuario desde la API
  • articulate360User(booleano): si el usuario está administrado o no en Articulate 360

Recuperando una lista de usuarios

GET /users

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se devolverán en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)
  • email(cadena, opcional): si se proporciona, solo devuelve a los usuarios con esta dirección de correo electrónico

Ejemplo de respuesta

{
«users»: [
{
«id»: «example-user-id-1", «email»: "foo@example.com 
 «, «groupURL»: "https://api.reach360.com/users/example-user-id-1/groups «, 
 «role»: «learner», «firstName»: 
 «Ejemplo de nombre 1", «lastName»: 
 «Ejemplo de apellido 1", «lastActiveAT»: 
 «2021-10-28T 20:39:52 .659 Z», 
 «learnerReportURL»: "https://api.reach360.com/reports/learners/example-user-id-1 «, «URL de favoritos»: "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"}

Recuperación de detalles de usuario específicos

GET /users/{userId}

Ejemplo de respuesta

{
«id»: «example-user-id», 
 «email»: "example@example.com «, «groupURL»: "https://api.reach360.com/users/example-user-id-1/groups 
 «, «role»: «learner», 
 «firstName»: «Ejemplo de nombre», 
 «lastName»: «Ejemplo de apellido», «lastActiveAT»: 
 «2021-10-28T 20:39:52 .659 Z», 
 «learnerReportURL»: "https://api.reach360.com/reports/learners/example-user-id «, «favorT URL del sitio»: "https://api.reach360.com/users/example-user-id/favorites 
 «, «url»: "https://api.reach360.com/users/example-user-id" «articulate360 
 
 
 Usuario»: false
}

Códigos de error específicos de un punto final

  • user_not_found- no se puede recuperar el usuario porque el usuario no existe

Eliminar usuarios por ID

DELETE /users/{userId}

  • Solo los alumnos que no estén gestionados con el SSO y que no tengan un Articulate ID se pueden eliminar con la API.

Ejemplo de respuesta de éxito

204 Sin contenido

Ejemplo de respuestas fallidas (solo se pueden eliminar los alumnos)

{
«errors»: [
{
«message»: «No puedes eliminar un usuario gestionado por 360", 
 «code»: «validation_failed»}]}

Ejemplo de respuesta a un error (los usuarios de SSO no se pueden eliminar)

{
«errores»: [
{
«mensaje»: «No se encontró ningún usuario», 
 «código»: «not_found»
}]}

Ejemplo de respuesta a un error (no se pueden eliminar los propietarios)

{
«errors»: [
{
«message»: «No puedes eliminar a un usuario que es el propietario», 
 «code»: «validation_failed»}]}

Ejemplo de respuesta a un error (los usuarios de Okta no se pueden eliminar)

{
«errores»: [
{
«mensaje»: «No se encontró ningún usuario», 
 «código»: «not_found»
}]}