Class Authentication

Hierarchy

Authentication

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Authentication(options: AuthOptions): Authentication

- Defined in index.d.ts:15
Parameters
- options: AuthOptions
Returns Authentication

Properties

dbConnection

dbConnection: DBConnection

passwordless

passwordless: PasswordlessAuthentication

Methods

buildAuthorizeUrl

buildAuthorizeUrl(options: AuthorizeUrlOptions): string

- Defined in index.d.ts:27
Builds and returns the /authorize url in order to initialize a new authN/authZ transaction

see

https://auth0.com/docs/api/authentication#authorize-client

see

https://auth0.com/docs/api/authentication#social

Parameters
- options: AuthorizeUrlOptions
Returns string

buildLogoutUrl

buildLogoutUrl(options?: LogoutOptions): string

- Defined in index.d.ts:34
Builds and returns the Logout url in order to initialize a new authN/authZ transaction

Parameters
- Optional options: LogoutOptions
Returns string

delegation

delegation(options: DelegationOptions, callback: Auth0Callback<Auth0DelegationToken, Auth0Error>): any

- Defined in index.d.ts:82
Makes a call to the /delegation endpoint

Parameters
- options: DelegationOptions
- callback: Auth0Callback<Auth0DelegationToken, Auth0Error>
Returns any

getSSOData

getSSOData(callback?: Auth0Callback<SsoDataResult, Auth0Error>): void
getSSOData(withActiveDirectories: boolean, callback?: Auth0Callback<SsoDataResult, Auth0Error>): void

- Defined in index.d.ts:63
Makes a call to the /ssodata endpoint

Parameters
- Optional callback: Auth0Callback<SsoDataResult, Auth0Error>
Returns void
- Defined in index.d.ts:69
Makes a call to the /ssodata endpoint

Parameters
- withActiveDirectories: boolean
- Optional callback: Auth0Callback<SsoDataResult, Auth0Error>
Returns void

getUserCountry

getUserCountry(callback: Auth0Callback<{ countryCode: string }, Auth0Error>): void

- Defined in index.d.ts:88
Fetches the user country based on the ip.

Parameters
- callback: Auth0Callback<{ countryCode: string }, Auth0Error>
Returns void

login

login(options: DefaultLoginOptions, callback: Auth0Callback<any, Auth0Error>): void

- Defined in index.d.ts:52
Makes a call to the oauth/token endpoint with password-realm grant type

Parameters
- options: DefaultLoginOptions
- callback: Auth0Callback<any, Auth0Error>
Returns void

loginWithDefaultDirectory

loginWithDefaultDirectory(options: DefaultDirectoryLoginOptions, callback: Auth0Callback<any, Auth0Error>): void

- Defined in index.d.ts:41
Makes a call to the oauth/token endpoint with password grant type

Parameters
- options: DefaultDirectoryLoginOptions
- callback: Auth0Callback<any, Auth0Error>
Returns void

loginWithResourceOwner

loginWithResourceOwner(options: ResourceOwnerLoginOptions, callback: Auth0Callback<any, Auth0Error>): void

- Defined in index.d.ts:47
Makes a call to the /ro endpoint

deprecated

loginWithResourceOwner will be soon deprecated, user login instead.

Parameters
- options: ResourceOwnerLoginOptions
- callback: Auth0Callback<any, Auth0Error>
Returns void

oauthToken

oauthToken(options: any, callback: Auth0Callback<any, Auth0Error>): void

- Defined in index.d.ts:57
Makes a call to the oauth/token endpoint

Parameters
- options: any
- callback: Auth0Callback<any, Auth0Error>
Returns void

userInfo

userInfo(accessToken: string, callback: Auth0Callback<Auth0UserProfile, Auth0Error>): void

- Defined in index.d.ts:75
Makes a call to the /userinfo endpoint and returns the user profile

Parameters
- accessToken: string
- callback: Auth0Callback<Auth0UserProfile, Auth0Error>
Returns void

Generated using TypeDoc