UNPKG

@digitalpersona/authentication

Version:
32 lines (18 loc) 1.15 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@digitalpersona/authentication](./authentication.md) &gt; [EmailOtpAuth](./authentication.emailotpauth.md) &gt; [authenticate](./authentication.emailotpauth.authenticate.md) ## EmailOtpAuth.authenticate() method Authenticates the user using a challenge sent to the user's registered e-mail address. <b>Signature:</b> ```typescript authenticate(identity: User | JSONWebToken, code: string): Promise<JSONWebToken>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | identity | <code>User &#124; JSONWebToken</code> | a or a JSON Web Token. | | code | <code>string</code> | a code the user received via e-mail challenge. | <b>Returns:</b> `Promise<JSONWebToken>` a promise to return a JSON Web Token containing a claim (`crd`<!-- -->) showing the fact a OTP 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.