ping-identity
    Preparing search index...

    Type Alias PasswordCollector

    PasswordCollector: BaseCollector & {
        clearPassword?: boolean;
        passwordPolicy?: PasswordPolicy;
        type: "PASSWORD" | "PASSWORD_VERIFY";
        validation?: DaVinciValidation;
        value: string;
    }

    Password input collector.

    Type Declaration

    • OptionalclearPassword?: boolean

      Whether the native collector clears its value when close() is called on node exit.

      Defaults to true on both platforms. Set to false to retain the password value across node transitions (e.g. validation-error retry loops).

    • OptionalpasswordPolicy?: PasswordPolicy

      Optional password policy constraints for rendering password requirements.

      The bridge reads the native passwordPolicy() accessor, which uses a field-level policy when available and otherwise falls back to a node-level policy.

    • type: "PASSWORD" | "PASSWORD_VERIFY"
    • Optionalvalidation?: DaVinciValidation

      Optional server-provided regular-expression validation rule.

    • value: string

      Current password value (always "" in bridge output because the bridge clears it before serialization).

    PASSWORD_VERIFY is a password-confirmation variant of the same collector class. Password values are write-only: pass them to next(). Use DaVinciClient.validate for on-demand validation of the current value.

    Settings

    Member Visibility