Users

Update user suspension status

Changed on

Update user suspension status for the given ID.

patch/api/users/{userId}/is-suspended

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/users/{userId}/is-suspended
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

userIdstring required

The unique identifier of the user.

Request body

isSuspendedboolean required

New suspension status for the user.

Response

User suspension status updated successfully.

idstring required
usernamestring nullable required
primaryEmailstring nullable required
primaryPhonestring nullable required
namestring nullable required
avatarstring nullable required
customDataobject required

arbitrary

identitiesobject required
lastSignInAtnumber nullable required
createdAtnumber required
updatedAtnumber required
applicationIdstring nullable required
cimdClientIdstring nullable required

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId.

isSuspendedboolean required
hasPasswordboolean
hasSecurityVerificationMethodboolean
passwordDigeststring nullable
passwordAlgorithm'Argon2i' | 'Argon2id' | 'Argon2d' | 'SHA1' | 'SHA256' | 'MD5' | 'Bcrypt' | 'Legacy' nullable

Changes

  • f6be196bc327Revision changes
    • breaking

      the response property's maxLength was increased from 12 to 128 for the response status

    • breaking

      the // response property's maxLength was increased from 12 to 128 for the response status

  • 0287c6a59ebaRevision changes
    • info

      added the required property to the response with the status