Appearance
Set User Active Status
Update a users active state. A disabled (not active) user will not be able to access the system. Their account will be locked, and they will not count towards your user limit.
Parameters
| name | type | data type | description |
|---|---|---|---|
targetPath | required | string | the path to the organization or tenant where the user record 'lives' |
userId | required | string | the user id of the user record you would like to enid |
body.active | required | boolean | the new active state of the user |
Return Value
JSON object of type boolean
Examples
bash
curl -X POST -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user/:userId/active -d "{"active": false}"ENDPOINTS
post
/api/{targetPath}/user/:userId/set-active-status