netexCloud - API de Web Services | Web services de usuario | Desactivar usuario.
Última modificación:
Desactiva un usuario.
- URL: /integration/ws/management/rest/users/<id_usuario_o_username>/deactivate
- Method: PUT
- Headers:
- Accept: version/format header
- X-Cloud-Auth-Token*: authorization header
- X-Cloud-Synchronization: synchronization header
- Content-Type (obligatorio si se incluye el parámetro opcional message): application/json
- Parameters:
- message (opcional): Mensaje asociado a la desactivación del usuario y que se muestra en la pantalla de login local si el usuario intenta acceder. Parámetro en el body de la request en formato json.
- 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
- location: ubicación del recurso resultante en la plataforma (si lo hubiere)
- message: mensaje de “éxito” o “error” en la plataforma, si lo hubiere
- 200: OK. Contenido:
- Ejemplo de Url por ID de usuario: http://<tenant>.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015572136a250012/deactivate
- Ejemplo de URL por nombre de usuario: http://<tenant>.learningcloud.me/integration/ws/management/rest/users/restuser.netex/deactivate
- Ejemplo de parámetro message:
{
"message"
:
"Lo sentimos, tu usuario está <strong>desactivado</strong>."
}
- 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": 202
},
"management": {
"location": null,
"message": null,
"status": 204
}
},
"status": 204
}