@digitalpersona/authentication
Version:
DigitalPersona Authentication API
36 lines • 1.73 kB
JavaScript
import { __extends } from "tslib";
import { Credential } from '@digitalpersona/core';
import { Authenticator } from '../../private';
/**
* Face authentication API.
* Face credential supports authentication. Identification is currently not supported by the server.
*/
var FaceAuth = /** @class */ (function (_super) {
__extends(FaceAuth, _super);
/** Constructs a new face authentication API object.
* @param authService - an {@link AuthService|authentication service client} connected to the server.
*/
function FaceAuth(authService) {
return _super.call(this, authService) || this;
}
/** Authenticates the user using their face images.
* @param identity - a {@link User |username} or a JSON Web Token.
* @param samples - a collection of biometric samples with face images.
* @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact
* a face was used.
* Will reject if authentication fails.
* @remarks
* If the `identity` parameter is a user name, a new token will be created.
* If the `identity` parameter is a JSON Web Token, an updated token will be returned.
*/
FaceAuth.prototype.authenticate = function (identity, samples) {
return _super.prototype._authenticate.call(this, identity, new Credential(Credential.Face, samples));
};
/** Currently face identification is not supported by the server. */
FaceAuth.prototype.identify = function (samples) {
return _super.prototype._identify.call(this, new Credential(Credential.Face, samples));
};
return FaceAuth;
}(Authenticator));
export { FaceAuth };
//# sourceMappingURL=auth.js.map