@digitalpersona/enrollment/src/tokens/password/enroll.ts

DigitalPersona Enrollment API

import { Credential, Ticket } from '@digitalpersona/core';
import { CustomAction } from './actions';
import { Enroller } from '../../private';
import { EnrollmentContext } from '../..';

/**
 * Password enrollment API.
 * @remarks
 * As a primary credential, user's password cannot be unenroled, it can only be changed, reset or randomized.
 */
export class PasswordEnroll extends Enroller
{
    /** Constructs a new password enrollment API object.
     * @param context - an {@link EnrollmentContext|enrollment context}.
     */
    constructor(context: EnrollmentContext){
        super(context);
    }

    /** Reads a password change availability.
     * @returns a fulfilled promise when a password can be changed, a rejected promise otherwise.
     */
    public canEnroll(): Promise<void>
    {
        return super._canEnroll(Credential.Password);
    }

    /**
     * Changes a password.
     * @param newPassword - a new password.
     * @param oldPassword - a password to replace. Must match the existing password.
     * @returns a promise to perform the password change or reject in case of an error.
     */
    public enroll(
        newPassword: string,
        oldPassword: string,
    ): Promise<void>
    {
        return super._enroll(new Credential(Credential.Password, {oldPassword, newPassword}));
    }

    /**
     * Resets a password.
     * @param newPassword - a new password which will replace any existing password.
     * @returns a promise to perform the password reset or reject in case of an error.
     * @remarks
     * DigitalPersona AD Server supports password randomization only for ActiveDirectory users.
     * DigitalPersona LDS Server supports password randomization only for DigitalPersona users (formerly "Altus Users").
     */
    public reset(
        newPassword: string,
    ): Promise<void>
    {
        return super._enroll(new Credential(Credential.Password, newPassword));
    }

    /**
     * Creates a new strong password with good complexity properties.
     * @returns a promise to return a randomized password.
     * @remarks
     * DigitalPersona AD Server supports password randomization only for ActiveDirectory users.
     * DigitalPersona LDS Server supports password randomization only for DigitalPersona users (formerly "Altus Users").
     */
    public randomize(): Promise<string>
    {
        return this.context.enrollService.CustomAction(
            new Ticket(this.context.securityOfficer || ""),
            this.context.getUser(),
            new Credential(Credential.Password),
            CustomAction.PasswordRandomization);
    }
}