Description

Using Disable User web service, manager can disable the user. 

Parameters

The following parameters are required in this web service.


organizationId: Defines the Organization Id of an Organization where that user exist.

username: Defines a unique username which will gives the existing user to be disabled.


Disable User curl command (Example)

curl --insecure -H "accept:application/json" -H "Content-Type:application/json" -H "X-Auth-Token:XXXXXX" -d '{organizationId:  "XXXXXXX-ddc9-481c-adad-XXXXXXXXXXX",username: "abc@email.com"}' https://app.genrocket.com/rest/user/disable


URL Request

https://app.genrocket.com/rest/user/disable


Payload Request (Example)

{  
   organizationId:"XXXXXXXXX-ddc9-481c-adad-XXXXXXXXXXXX",
   username:"abc@email.com"
}


Payload OK Response (Example)

{
  "errors": {
  },
  "fields": {
    "externalId": "XXXXXX-7001-4c4f-b5c8-XXXXXXXX",
    "firstName": "Test",
    "lastName": "XYZ",
    "username": "abc@email.com",
    "enabled": false,
    "roles": 
    [
      "ROLE_USER"
    ]
  },
  "success": true
}


Payload Error Response (Example)

{
  "success": false,
  "errors": {
    "error": "Error message"
  }
}