Skip to main content

Account Management

Enable/disable accounts and manage account status.

Enable/Disable Account​

GET /api/users/{username}/enabled​

Check if user account is enabled.

Authentication: Required

Permissions: user:edit

Response:

A bare boolean: true when the account is enabled, false otherwise.

Check if an account is enabledGET /api/users/annie.larson/enabled
Responds with the boolean enabled flag.
Response · 200
true
Captured from the API examples test suite; ids and timestamps are normalized.

PUT /api/users/{username}/enabled​

Enable or disable a user account.

Authentication: Required

Permissions: user:edit

Request Body:

FieldTypeRequiredDescription
enabledbooleanYesWhether the account can sign in

Response:

Echoes the submitted { enabled } body.

Enable or disable an accountPUT /api/users/annie.larson/enabled
Sets the enabled flag explicitly. Echoes the submitted body.
Request body
{
  "enabled": false
}
Response · 200
{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/users/annie.larson/enabled"
    }
  },
  "enabled": false
}
Captured from the API examples test suite; ids and timestamps are normalized.

Use Case:

Reactivate a disabled account, or suspend access without deleting it.

DELETE /api/users/{username}/enabled​

Disable a user account (shorthand for PUT enabled with false).

Authentication: Required

Permissions: user:edit

Response:

Responds 200 with an empty body. Sets enabled: false, preventing login without deleting the account.

Disable an account (shorthand)DELETE /api/users/annie.larson/enabled
Convenience form of PUT enabled false. Responds 200 with an empty body.
Response · 200 · no body
Captured from the API examples test suite; ids and timestamps are normalized.

Use Case:

Temporarily suspend a user's access.

Account Locking​

After too many failed logins an account locks automatically. Clear the lock with:

PUT /api/users/{username}/unlock​

Unlock a locked user account.

Authentication: Required

Permissions: user:edit

Response:

Responds 200 with an empty body. Clears locked, lockedAt, and the failed loginAttempts counter.

Unlock an accountPUT /api/users/annie.larson/unlock
Clears the lock flag, lock timestamp, and failed login counter. Responds 200 with an empty body.
Response · 200 · no body
Captured from the API examples test suite; ids and timestamps are normalized.

Related endpoint:

  • PUT /api/users/\{username\} - update lock status fields directly

Account Deletion​

See Core CRUD for account deletion.

Endpoint:

  • DELETE /api/users/\{username\} - Permanently delete account

Warning:

Account deletion is permanent and removes all user data.