The enable user settings control whether a user’s ability to authenticate is activated or deactivated. This endpoint gives administrators the ability to turn on (or off) a user’s active status.
For information about users, see Users.
Property | Type | Required? | Mutable? | Description |
---|---|---|---|---|
enabled |
Boolean | Required | Mutable | Specifies whether the user is enabled. This attribute is set to true by default when the user is created. |
id |
String | Required | Mutable | Specifies the user resource’s unique identifier. |
Code | Message |
---|---|
200 | Successful operation. |
204 | Successfully removed. No content. |
400 | The request could not be completed. |
401 | You do not have access to this resource. |
404 | The requested resource was not found. |