Class Passwordless

Handles passwordless flows using Email and SMS.

Hierarchy (View Summary)

BaseAuthAPI
- Passwordless

Index

Constructors

Methods

sendEmail sendSMS loginWithEmail loginWithSMS request

Properties

domain clientId clientSecret? clientAssertionSigningKey? clientAssertionSigningAlg? useMTLS? configuration

Constructors

constructor

new Passwordless(configuration: AuthenticationClientOptions): Passwordless
Parameters
- configuration: AuthenticationClientOptions
Returns Passwordless
Overrides BaseAuthAPI.constructor

Methods

sendEmail

sendEmail(
bodyParameters: SendEmailRequest,
initOverrides?: InitOverride,
): Promise<VoidApiResponse>
Start passwordless flow sending an email.

Given the user email address, it will send an email with:
- A link (default, `send:"link"`). You can then authenticate with this user opening the link and he will be automatically logged in to the application. Optionally, you can append/override parameters to the link (like `scope`, `redirect_uri`, `protocol`, `response_type`, etc.) using `authParams` object.
- A verification code (`send:"code"`). You can then authenticate with this user using the `/oauth/token` endpoint specifying `email` as `username` and `code` as `password`.
See: https://auth0.com/docs/api/authentication#get-code-or-link
Parameters
- bodyParameters: SendEmailRequest
- OptionalinitOverrides: InitOverride
Returns Promise<VoidApiResponse>
Example
```
const auth0 = new AuthenticationApi({
   domain: 'my-domain.auth0.com',
   clientId: 'myClientId',
   clientSecret: 'myClientSecret'
});

await auth0.passwordless.sendEmail({
  email: '{EMAIL}',
  send: 'link',
  authParams: {} // Optional auth params.
});
```

sendSMS

sendSMS(
bodyParameters: SendSmsRequest,
initOverrides?: InitOverride,
): Promise<VoidApiResponse>
Start passwordless flow sending an SMS.

Given the user phone_number, it will send a SMS message with a verification code. You can then authenticate with this user using the /oauth/token endpoint specifying phone_number as username and code as password:

See: https://auth0.com/docs/api/authentication#get-code-or-link
Parameters
- bodyParameters: SendSmsRequest
- OptionalinitOverrides: InitOverride
Returns Promise<VoidApiResponse>
Example
```
const auth0 = new AuthenticationApi({
   domain: 'my-domain.auth0.com',
   clientId: 'myClientId',
   clientSecret: 'myClientSecret'
});

await auth0.passwordless.sendSMS({
  phone_number: '{PHONE}'
});
```

loginWithEmail

loginWithEmail(
bodyParameters: LoginWithEmailRequest,
options?: GrantOptions,
): Promise<JSONApiResponse<TokenSet>>
Once you have a verification code, use this endpoint to login the user with their email and verification code.
Parameters
- bodyParameters: LoginWithEmailRequest
- options: GrantOptions = {}
Returns Promise<JSONApiResponse<TokenSet>>
Example
```
const auth0 = new AuthenticationApi({
   domain: 'my-domain.auth0.com',
   clientId: 'myClientId',
   clientSecret: 'myClientSecret'
});

await auth0.passwordless.loginWithEmail({
  email: 'foo@example.com',
  code: 'ABC123'
});
```

loginWithSMS

loginWithSMS(
bodyParameters: LoginWithSMSRequest,
options?: GrantOptions,
): Promise<JSONApiResponse<TokenSet>>
Once you have a verification code, use this endpoint to login the user with their phone number and verification code.
Parameters
- bodyParameters: LoginWithSMSRequest
- options: GrantOptions = {}
Returns Promise<JSONApiResponse<TokenSet>>
Example
```
const auth0 = new AuthenticationApi({
   domain: 'my-domain.auth0.com',
   clientId: 'myClientId',
   clientSecret: 'myClientSecret'
});

await auth0.passwordless.loginWithSMS({
  phone_number: '0777777777',
  code: 'ABC123'
});
```

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAuthAPI.request

Properties

domain

domain: string

clientId

clientId: string

`Optional`clientSecret

clientSecret?: string

`Optional`clientAssertionSigningKey

clientAssertionSigningKey?: string

`Optional`clientAssertionSigningAlg

clientAssertionSigningAlg?: string

`Optional`useMTLS

useMTLS?: boolean

`Protected`configuration

configuration: Configuration