ping-identity
    Preparing search index...

    Type Alias PasswordCollector

    PasswordCollector: BaseCollector & {
        clearPassword?: boolean;
        passwordPolicy?: PasswordPolicy;
        type: "PASSWORD" | "PASSWORD_VERIFY";
        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.

      Present only when the server includes a passwordPolicy object in the field definition. The bridge reads it directly from the raw JSON because the SDK's passwordPolicy() method targets the wrong path in 2.0.1.

    • type: "PASSWORD" | "PASSWORD_VERIFY"
    • value: string

      Current password value (always "" in bridge output — cleared before serialisation).

    PASSWORD_VERIFY is a password-confirmation variant of the same collector class.