netexCloud - API de Web Services | Web services de usuario | Actualización del usuario

Actualización del usuario

Actualiza un usuario.

• URL: /integration/ws/management/rest/users/<id_o_externalId_o_commonId_o_username>
• Method: PUT
• Headers:
  • Accept: encabezado de versión/formato
  • X-Cloud-Auth-Token*: encabezado de autorización
  • X-Cloud-Synchronization: encabezado de sincronización
  • Content-Type*: application/json
• Parameters:
  • user*: usuario a actualizar
    • name*: nuevo nombre del usuario
    • surname*: nuevo apellido del usuario
    • language*: Nuevo código de idioma del usuario
    • timezone*: nuevo código de huso horario del usuario
    • email*: Nuevo e-mail del usuario
    • username*: Nuevo nombre de usuario
    • officePhone: Nuevo número teléfono de oficina del usuario
    • mobilePhone: nuevo número de móvil del usuario
    • interests: nuevos intereses del usuario
    • aboutMe: nueva información del usuario
    • location: nueva ubicación del usuario
    • authSource: sistema donde se comprueban las credenciales del usuario
    • image: nueva imagen del usuario, puede ser especificada como:
      • url: url en la que se encuentra la imagen ({"url": "image_url"})
      • base64: datos de imagen ({"base64Image": "image_data", "mimeType": "image_mimeType"})
    • enabled: nuevo estado de activación del usuario
    • roles: nuevos roles de usuario. Especificado como un mapa con la sección como clave y la lista de role como valor. Los valores validos 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, groupadmin
      • talent: admin, employee
      • content: author, manager, reviewer, projectowner
    • extendedFields: Mapa clave/valor para los valores de los campos extendidos del al usuario
    • externalId: Id externo del usuario.
    • extra:
• Responses:
  • 200: OK. Contenido:
    • status: estado genérico
    • location: ubicación genérica del recurso resultante (si lo hubiere)
    • message: mensaje genérico de “éxito” o “error” (si lo hubiere).
    • responsePlatforms: respuesta para cada plataforma a la que afecta. Cada una con el contenido:
      • status: estado en la plataforma (si lo hubiere)
      • location: localización del recurso resultante en la plataforma (si lo hubiere)
      • message: mensaje de “éxito” o “error” en la plataforma (si lo hubiere)

• Ejemplo de url por id: http://netex.dev.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015572136a250012
• Ejemplo de url por nombre de usuario: http://netex.dev.learningcloud.me/integration/ws/management/rest/users/restuser.acme

• Ejemplo de respuesta (síncrona):

{

"location": null,

"message": "",

"responsePlatforms": {

"training": {

"location": null,

"message": null,

"status": 200

},

"social": {

"location": null,

"message": null,

"status": 204

},

                "play": {
                      "location": null,
                      "message": null,
                       "status": 204
                 },

"management": {

"location": null,

"message": null,

"status": 204

}

},

"status": 204

}

• 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": 204
                 },

"management": {

"location": null,

"message": null,

"status": 204

}

},

"status": 204

}