Sign in
Users

Set User password

Changed on

Set user password.

<div> <code>update:user_passwords</code> </div>
put/api/v1/users/{user_id}/password

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/users/{user_id}/password
  • Auth: HTTP bearer

Path parameters

user_idstring required

The identifier for the user

Request body

hashed_passwordstring required

The hashed password. For aspnet-identity-v2, provide the base64-encoded AspNetUsers.PasswordHash value as-is.

hashing_method'bcrypt' | 'crypt' | 'md5' | 'sha256' | 'wordpress' | 'pbkdf2' | 'firebase-scrypt' | 'aspnet-identity-v2'

The hashing method or algorithm used to encrypt the user’s password. Default is bcrypt.

saltstring

Extra characters added to passwords to make them stronger. Not required for bcrypt. Required for pbkdf2; provide the base64-encoded salt. Required for firebase-scrypt; provide the base64-encoded per-user salt. Not used for aspnet-identity-v2 (the salt is embedded in the hash); do not provide salt, salt_position, iterations, or variant with aspnet-identity-v2.

salt_position'prefix' | 'suffix'

Position of salt in password string. Not required for bcrypt.

iterationsinteger

The iteration count (factor) used to derive the hash. Optional for pbkdf2; when omitted, verification defaults to 24000 (the FusionAuth default factor). Rejected for firebase-scrypt.

variantstring

The hashing variant. Required for pbkdf2 (e.g. salted-pbkdf2-hmac-sha256, salted-pbkdf2-hmac-sha256-512, salted-pbkdf2-hmac-sha512-512). Rejected for firebase-scrypt.

signer_keystring

The base64-encoded signer key from the Firebase project's password hash parameters. Required for firebase-scrypt; rejected for other hashing methods.

salt_separatorstring

The base64-encoded salt separator from the Firebase project's password hash parameters. Required for firebase-scrypt; rejected for other hashing methods.

roundsinteger

The scrypt rounds from the Firebase project's password hash parameters (1-16). Required for firebase-scrypt; rejected for other hashing methods.

mem_costinteger

The scrypt memory cost from the Firebase project's password hash parameters (1-20). Required for firebase-scrypt; rejected for other hashing methods.

is_temporary_passwordboolean

The user will be prompted to set a new password after entering this one.

Response

User successfully created.

messagestring
codestring

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes

  • 3557b4b818eaRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new aspnet-identity-v2 enum value to the request property

    • info

      added the new firebase-scrypt enum value to the request property

  • bfffc845554dRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new pbkdf2 enum value to the request property

    • info

      added the new sha256 enum value to the request property