Admin

Deactivate a user

Changed on

Block a user from signing in and end all of their sessions. Their data stays. Requires the users:disable instance permission; API keys are rejected.

post/admin/users/{userId}/deactivate

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/admin/users/{userId}/deactivate
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Response

The deactivated user

idstring required
namestring required
emailstring required
emailVerifiedboolean required
isAnonymousboolean required
imagestring nullable required
createdAtstring date-time required
updatedAtstring date-time required
rolestring nullable required
bannedboolean required
banReasonstring nullable required
banExpiresstring date-time nullable required
lastActiveAtstring date-time nullable required

When one of the user's current sessions was last refreshed; null without a session.

signInMethodsstring[] required

Linked sign-in methods: credential (password), github, google, discord, or custom (OIDC).

Changes