MonoCloud Management SDK
    Preparing search index...

    Interface SetPasswordRequest

    Set Password Request: Used to set or update a user's password, with support for plaintext or pre-hashed values.

    SetPasswordRequest

    interface SetPasswordRequest {
        is_temporary_password?: boolean;
        password?: string | null;
        password_hash?: string | null;
        password_hash_algorithm?: "bcrypt";
        revoke_sessions?: boolean;
        skip_password_policy_checks?: boolean;
    }
    Index

    Properties

    is_temporary_password? password? password_hash? password_hash_algorithm? revoke_sessions? skip_password_policy_checks?

    Properties

    is_temporary_password?: boolean

    Indicates whether the provided password is temporary. If true, the user must reset their password at their next sign-in.

    SetPasswordRequest

    password?: string | null

    Plain-text password to assign to the user.

    SetPasswordRequest

    password_hash?: string | null

    A pre-hashed password value. Useful during migrations to avoid forcing a password reset.

    When provided, password validation and password policy requirements are not enforced. The hash is stored as-is.

    SetPasswordRequest

    password_hash_algorithm?: "bcrypt"

    Hashing algorithm used for the provided password hash.

    SetPasswordRequest

    revoke_sessions?: boolean

    A flag to indicate whether all active user sessions should be revoked when the password is updated.

    SetPasswordRequest

    skip_password_policy_checks?: boolean

    Allows bypassing configured password policy checks.

    SetPasswordRequest

    Settings

    On This Page

    Properties