Class Database

Sign-up and change-password for Database & Active Directory authentication services.

Hierarchy (View Summary)

BaseAuthAPI
- Database

Index

Constructors

Methods

signUp changePassword request

Properties

domain clientId clientSecret? clientAssertionSigningKey? clientAssertionSigningAlg? useMTLS? configuration

Constructors

constructor

new Database(options: AuthenticationClientOptions): Database
Parameters
- options: AuthenticationClientOptions
Returns Database

Inherited from BaseAuthAPI.constructor

Methods

signUp(
bodyParameters: SignUpRequest,
initOverrides?: InitOverride,
): Promise<JSONApiResponse<SignUpResponse>>
Given a user's credentials, and a connection, this endpoint will create a new user using active authentication.

This endpoint only works for database connections.

See: https://auth0.com/docs/api/authentication#signup
Parameters
- bodyParameters: SignUpRequest
- OptionalinitOverrides: InitOverride
Returns Promise<JSONApiResponse<SignUpResponse>>
Example
```
var data = {
  email: '{EMAIL}',
  password: '{PASSWORD}',
  connection: 'Username-Password-Authentication'
};

await auth0.database.signUp(data);
```

changePassword

changePassword(
bodyParameters: ChangePasswordRequest,
initOverrides?: InitOverride,
): Promise<TextApiResponse>
Given a user's email address and a connection, Auth0 will send a change password email.

This endpoint only works for database connections.

See: https://auth0.com/docs/api/authentication#change-password
Parameters
- bodyParameters: ChangePasswordRequest
- OptionalinitOverrides: InitOverride
Returns Promise<TextApiResponse>
Example
```
var data = {
  email: '{EMAIL}',
  connection: 'Username-Password-Authentication'
};

await auth0.database.changePassword(data);
```

`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