HAha-man2
User

Delete Expired Users

Changed on

Delete cleanup-target users in the specified scope.

  • target: expired | limited | on_hold | disabled | inactive
  • expired_after / expired_before UTC datetime (optional)
  • For expired: filters by expiration date.
  • For limited / on_hold / disabled: filters by last_status_change (when they entered that status).
  • For inactive: filters by last activity (online_at, or created_at if never online); expired_before is required.
  • dry_run: if true, returns users that would be deleted without deleting them.
delete/api/users/expired

Request

  • Base URL
    https://api.ha-man2.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ha-man2.com/api/users/expired
  • Auth
    OAuth 2
    Password
    Token URL: /api/admin/token

Query parameters

admin_usernamestring nullable
target'expired' | 'limited' | 'on_hold' | 'disabled' | 'inactive'
expired_afterstring date-time nullable
Example:2024-01-01T00:00:00+03:30
expired_beforestring date-time nullable
Example:2024-01-31T23:59:59+03:30
dry_runboolean

Response

Successful Response

usersstring[] required
countinteger required

Changes

  • a7dc3fda908fRevision changes
    • info

      added the new optional query request parameter dry_run

    • info

      added the new enum value disabled to the query request parameter target

    • info

      added the new enum value inactive to the query request parameter target

    • info

      added the new enum value on_hold to the query request parameter target