Users

Update user password expiration

Update the user's password expiration state for the next sign-in attempt.

patch/api/users/{userId}/password/expiration

Request

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

Path parameters

userIdstring required

The unique identifier of the user.

Request body

isExpiredboolean required

Whether the user's password should be marked as expired.

Response

User password expiration state has been 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