Users / Activate deactivate
Disables, or re-activates a users access on tenant
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/users/activate_deactivate/{id}
Method: POST
Authorisation: Minimum role: ADMIN
Request Arguments
| Name | Type | Source |
|---|---|---|
| id | Int32 | |
| input | DTO_user_activate_deactivate | Body |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_acknowledgement
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_user_activate_deactivate
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| status | ENUM tenant_user_status | Status |
DTO_acknowledgement
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| message | String | Message |
ENUM tenant_user_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | ACTIVE | ACTIVE |
| 2 | DEACTIVE | DEACTIVE |
