UserList

Utilice este recurso para devolver una lista de usuarios en la cuenta de usuario autenticada en formato JSON o CSV.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP Vía de acceso Descripción
GET /scr/api/UserList Devuelve una lista de los usuarios en la cuenta de usuarios autenticada.

GET/scr/api/UserList

Descripción
Utilice este método para devolver una lista de usuarios en la cuenta de usuario autenticada en formato JSON o CSV.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON o CSV
Requiere autenticación Sí. El usuario que realiza la solicitud debe ser un administrador.
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de usuarios
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
format Consulta Formato a devolver. Utilice csv para especificar CSV. Si no se indica este parámetro, se devuelve formato JSON. Nee Serie
version Consulta Versión de la API solicitada. La respuesta puede variar en función de la versión solicitada. Los valores posibles son:
  • 20110917
  • 20091212 (en desuso)
Actualmente, si no se proporciona este parámetro, se devuelven los resultados de la versión 20091212. En un futuro release, este parámetro en desuso se ignorará y se utilizará la versión 20110917.		 Núm. Este parámetro puede ser necesario en el futuro. Serie
Respuesta para la versión 20110917
Entrada de ejemplo
Lista (GET) de todos los usuarios de la cuenta en formato JSON:
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/UserList?version=20110917"
Lista (GET) de todos los usuarios de la cuenta en formato CSV:
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/UserList?version=20110917&format=csv"
Resultado de ejemplo
En formato JSON:
{
  "version":"20110917",
  "users":[
    {
      "name":"username1",
      "id":"7000f",
      "email":"user1_email@website.com",
      "avatarId":"70010",
      "license":"Editor",
      "admin":true,
      "date":1310654350393,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150005", "name": "department1" }
    },
    {
      "name":"username2",
      "id":"70022",
      "email":"user2_email@website.com",
      "license":"Community",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150006", "name": "department2" }
    },
    {
      "name":"username3",
      "id":"70021",
      "email":"user3_email@website.com",
      "license":"Contributor",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150007", "name": "department3" }
    },
    {
      "name":"username4",
      "id":"70020",
      "email":"user4_email@website.com",
      "license":"Viewer",
      "admin":false,
      "date":1310653543628,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150008", "name": "department4" }
    }
  ]
}
En formato CSV:
"License Type","Full Name","Email Address","Business Unit","Administrator",
"Last Login / Invite / Archive Date (Eastern Standard Time)","Archived","Invited","Licensed","Locked"
Editor, "username1", "user1_email@website.com", "Department 1", Yes, "2011/07/14 02:39:10", No, No, Yes, No
Community, "username2", "user2_email@website.com", "", No, "", No, No, Yes, No
Contributor, "username3", "user3_email@website.com", "", No, "", No, No, Yes, No
Viewer, "username4", "user4_email@website.com", "", No, "2011/07/14 02:25:43", No, No, Yes, No
Propiedades de respuesta
version
Versión de la API que se ha utilizado para crear la respuesta.
users
Matriz de objetos de usuario.
user.name
Nombre completo del usuario.
user.id
El ID del usuario.
user.email
La dirección de correo electrónico del usuario.
user.avatarId
ID del avatar del usuario.
user.license
Contiene uno de los siguientes valores posibles:
  • Editor
  • Contributor
  • Community
  • Viewer
user.admin
Contiene uno de los siguientes valores posibles:
  • true si el usuario es un administrador
  • false si el usuario no es un administrador
user.date
Esta propiedad depende de los valores de las propiedades archived y invited.
  • Si archived es true, entonces es la fecha en la que se archivó el usuario.
  • Si invited es true, entonces es la fecha en la que se invitó al usuario.
  • En todas las demás instancias, es la fecha del inicio de sesión más reciente del usuario.
  • Si todos los valores son nulos, la propiedad date no está presente.
El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC).
user.archived
Contiene uno de los siguientes valores posibles:
  • true si el usuario está archivado
  • false si el usuario no está archivado
user.invited
Contiene uno de los siguientes valores posibles:
  • true si el usuario está invitado
  • false si el usuario no está invitado
user.licensed
Contiene uno de los siguientes valores posibles:
  • true si el usuario tiene licencia, es decir, si el usuario está incluido en el recuento de licencias utilizadas
  • false si el usuario no está incluido en el recuento de licencias utilizadas
user.locked
El valor es true si el usuario está bloqueado, es decir, si el usuario no puede iniciar sesión en este momento. De lo contrario, el valor es false.
user.businessUnit
Departamento, división, grupo de trabajo o área funcional en los que trabaja el usuario.
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
401

El usuario no está autorizado a realizar la petición.