• auth
• Database

Class Database

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

Hierarchy (View Summary)

• BaseAuthAPI
  • Database

Index

Constructors

constructor

Methods

signUpchangePasswordrequest

Properties

domainclientIdclientSecret?clientAssertionSigningKey?clientAssertionSigningAlg?useMTLS?configuration

Constructors

constructor

new Database(options: AuthenticationClientOptions): Database

Parameters

• options: AuthenticationClientOptions

Returns Database

Methods

signUp

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);Copy

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);Copy

Protectedrequest

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>

Parameters

• context: RequestOpts
• OptionalinitOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

Properties

domain

domain: string

clientId

clientId: string

OptionalclientSecret

clientSecret?: string

OptionalclientAssertionSigningKey

clientAssertionSigningKey?: string

OptionalclientAssertionSigningAlg

clientAssertionSigningAlg?: string

OptionaluseMTLS

useMTLS?: boolean

Protectedconfiguration

configuration: Configuration

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods signUpchangePasswordrequest Properties domainclientIdclientSecretclientAssertionSigningKeyclientAssertionSigningAlguseMTLSconfiguration