netexCloud - Web Services API | User web services | Deactivate user

Deactivates a user by id or username.

• Url: /integration/ws/management/rest/users/<user_id_or_username>/deactivate
• Method: PUT
• Headers:
  
  • Accept: version/format header 
  • X-Cloud-Auth-Token*: authorization header 
  • X-Cloud-Synchronization: synchronization header 
  • Content-Type (mandatory if optional message parameter included): application/json
• Responses:
  
  • 200: OK. Content:
    
    • status: generic status
    • location: generic location of the resultant resource, if any
    • message: generic success or error message, if any
    • responsePlatforms: response for every platform it concerns. Each one with the content:
      
      • status: status in the platform
      • location: location of the resultant resource in the platform, if any
      • message: success or error message in the platform, if any
• Url example by user id:

  http://<tenant>.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015572136a250012/deactivate

• Url example by username:

  http:// <tenant>.learningcloud.me/integration/ws/management/rest/users/restuser.netex/deactivate

• Message parameter example:

{
  "message": "Sorry, your user is deactivated."
}

• Response example (synchronous):

{
    "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
}