POST v2/api/users/{id}/enabled
Sets the activity of the specified Interactive User. Disabling a user also deactivates all associated API Credentials. Re-enabling a user sets them back to their exact previous active state - i.e. password and API Credentials are exactly as they were. This API call can only be made by the Administrator who created the target user.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
id | The identifier. |
Define this parameter in the request URI. |
newStateInput | The new activity state. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
{ "Enabled": "sample string 1" }
Response Information
The newly updated Interactive User with their API Credentials is returned. This endpoint can only be called by the Administrator who created the target user, otherwise a 403:Forbidden is returned. The user's state must be a valid state, otherwise a 400:BadRequest is returned.
Response body formats
application/json, text/json
{ "Id": "42050e1b-4054-4c81-8da2-d89dd36d0318", "Name": "sample string 2", "Username": "sample string 3", "Role": "sample string 4", "Credentials": [ { "Id": "7254f279-26b7-4671-8d8e-1821a70dacee", "Enabled": true, "Created": "2025-07-01T06:47:24.3339719+00:00" }, { "Id": "7254f279-26b7-4671-8d8e-1821a70dacee", "Enabled": true, "Created": "2025-07-01T06:47:24.3339719+00:00" }, { "Id": "7254f279-26b7-4671-8d8e-1821a70dacee", "Enabled": true, "Created": "2025-07-01T06:47:24.3339719+00:00" } ], "Enabled": true, "Created": "2025-07-01T06:47:24.3339719+00:00" }