netexCloud - API de Web Services | Web services de usuario | Creación de un usuario
Última modificación:
Creación de un usuario
Crear un usuario.
- URL: /integration/ws/management/rest/users
- Method: POST
- Headers:
- Accept: encabezado de versión/formato
- X-Cloud-Auth-Token*: encabezado de autenticación
- X-Cloud-Synchronization: encabezado de sincronización
- Content-Type*: application/json
- Parameters:
- user*: usuario a crear:
- username: nombre del usuario
- password: contraseña del usuario
- name: nombre del usuario
- surname: apellido del usuario
- language: código de idioma del usuario
- timezone: huso horario del usuario
- email: email del usuario
- officePhone: número de teléfono de la oficina del usuario
- mobilePhone: número de móvil del usuario
- interests: intereses del usuario
- aboutMe: información del usuario
- location: ubicación del usuario
- authSource: sistema donde se comprueban las credenciales del usuario, LOCAL si no se especifica
- image: imagen del usuario. Puede ser especificada como:
- url: url en la que se encuentra la imagen ({"url": "image_url"})
- base64: datos de la imagen ({"base64Image": "image_data", "mimeType": "image_mimeType"})
- enabled: estado de activación del usuario
- roles: roles de usuario especificados como un mapa con la sección como clave y la lista de rol como valor. Los valores permitidos son:
- management: obligatorio al menos uno de los siguientes: user, groupadmin, admin
- training: user, trainer, groupadmin, admin
- social: user, admin
- play: user, author, validator, admin
- extendedFields: Mapa clave/valor para los valores de los campos extendidos del al usuario
- externalId: Id externo del usuario
- user*: usuario a crear:
- Responses:
- 200: OK. Contenido:
- status: estado general
- location: ubicación genérica del recurso resultante (si lo hubiere)
- message: mensaje genérico de “éxtio” o “error” (si lo hubiere)
- responsePlatforms: respuesta para cada plataforma a la que afecta, cada una con el contenido:
- status: estado en la plataforma
- location: ubicación del recurso resultante en la plataforma (si lo hubiere)
- message: mensaje de “éxito” o “error” en la plataforma (si lo hubiere)
- 400: Si se envía una petición sin username o el username al que se quiere cambiar ya existe
- 200: OK. Contenido:
- Ejemplo de respuesta (síncrona):
Header Location: http://<tenant>.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015571fe3d52000e
{
"location": null,
"message": "",
"responsePlatforms": {
"training": {
"location": null,
"message": null,
"status": 201
},
"social": {
"location": null,
"message": null,
"status": 201
},
"play": {
"location": null,
"message": null,
"status": 200
}
"management": {
"location": null,
"message": null,
"status": 201
}
},
"status": 201
}
- Ejemplo de respuesta (asíncrona):
{
"location": null,
"message": "",
"responsePlatforms": {
"training": {
"location": null,
"message": null,
"status": 202
},
"social": {
"location": null,
"message": null,
"status": 202
},
"play": {
"location": null,
"message": null,
"status": 200
}
"management": {
"location": null,
"message": null,
"status": 201
}
},
"status": 201
}