user.org.remove

The user.org.remove command is used to revoke a user's access to an organization.

Required Org-Admin rights.

TR50 Request


                        {
  "cmd": {
    "command": "user.org.remove",
    "params": {
      "userId": "52a1d3db169e1fd03217940d",
      "orgId": "52fd032179402a1d3db169e1"
    }
  }
}
      

Request Parameters

Name

Type

Required

Description

userId

String

Yes

The object Id of the user.

orgId

String

 

Defaults to the organization of the current session. Requires Super-Ops to override.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true
  }
}