Sign in
Users

Unset a user's password as compromised

Sets the given user's password as no longer compromised. The user will no longer be prompted to reset their password on their next sign-in.

If the user is in reserved-email password quarantine, the quarantine is preserved and the returned user will still have requires_password_reset set to true. Reserved-email password quarantine can only be cleared by completing a password reset or changing/removing the password.

post/users/{user_id}/password/unset_compromised

Path parameters

user_idstring required

The ID of the user to unset the compromised status for

Response

Success

idstring required
object'user' required

String representing the object's type. Objects of the same type share the same value.

external_idstring nullable required
primary_email_address_idstring nullable required
primary_phone_number_idstring nullable required
primary_web3_wallet_idstring nullable required
usernamestring nullable required
first_namestring nullable required
last_namestring nullable required
localestring nullable
profile_image_urlstring
image_urlstring
has_imageboolean required
public_metadataobject required
private_metadataobject nullable
unsafe_metadataobject
password_enabledboolean required
two_factor_enabledboolean required
totp_enabledboolean required
backup_code_enabledboolean required
mfa_enabled_atinteger nullable required

Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.

mfa_disabled_atinteger nullable required

Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.

password_last_updated_atinteger nullable

Unix timestamp of when the user's password was last updated.

last_sign_in_atinteger nullable required

Unix timestamp of last sign-in.

bannedboolean required

Flag to denote whether user is banned or not.

lockedboolean required

Flag to denote whether user is currently locked, i.e. restricted from signing in or not.

deprovisionedboolean

Flag to denote whether user has been deprovisioned and is restricted from signing in.

lockout_expires_in_secondsinteger nullable required

The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.

verification_attempts_remaininginteger nullable required

The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.

updated_atinteger required

Unix timestamp of last update.

created_atinteger required

Unix timestamp of creation.

delete_self_enabledboolean required

If enabled, user can delete themselves via FAPI.

create_organization_enabledboolean required

If enabled, user can create organizations via FAPI.

create_organizations_limitinteger nullable

The maximum number of organizations the user can create. 0 means unlimited.

last_active_atinteger nullable required

Unix timestamp of the latest session activity, with day precision.

legal_accepted_atinteger nullable required

Unix timestamp of when the user accepted the legal requirements.

bypass_client_trustboolean

When set to true, the user will bypass Device Trust checks during sign-in.

Example response

{
  "last_active_at": 1700690400000,
  "legal_accepted_at": 1700690400000
}

Changes

Changed in 2 of the 15 revisions of this API.3

  • 405105aa16c31See the full diff
    • ○

      added the optional property organization_memberships/items/public_user_data/deprovisioned to the response with the 200 status

      response-optional-property-added

  • 11bb1ccf4b7d2See the full diff
    • ○

      added the optional property email_addresses/items/verification/oneOf[verification_otp]/channel to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property phone_numbers/items/verification/oneOf[verification_otp]/channel to the response with the 200 status

      response-optional-property-added