WebAuth

WebAuth

new WebAuth(options)

Handles all the browser's AuthN/AuthZ flows

Source:
See:
Parameters:
Name Type Description
options Object
Name Type Attributes Description
domain String

your Auth0 domain

clientID String

the Client ID found on your Application settings page

redirectUri String <optional>

url that the Auth0 will redirect after Auth with the Authorization Response

responseType String <optional>

type of the response used by OAuth 2.0 flow. It can be any space separated list of the values code, token, id_token. https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html

responseMode String <optional>

how the Auth response is encoded and redirected back to the client. Supported values are query, fragment and form_post. The query value is only supported when responseType is code. https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#ResponseModes

scope String <optional>

scopes to be requested during Auth. e.g. openid email

audience String <optional>

identifier of the resource server who will consume the access token issued after Auth

leeway Number <optional>

number of seconds to account for clock skew when validating time-based claims in ID tokens. Defaults to 60 seconds.

maxAge Number <optional>

maximum elapsed time in seconds since the last time the user was actively authenticated by the authorization server.

plugins Array <optional>
_timesToRetryFailedRequests Number <optional>

Number of times to retry a failed request, according to https://github.com/visionmedia/superagent/blob/master/lib/request-base.js

Methods

renderCaptcha(element, options, callbackopt)

Renders the captcha challenge in the provided element. This function can only be used in the context of a Classic Universal Login Page.

Source:
Parameters:
Name Type Attributes Description
element HTMLElement

The element where the captcha needs to be rendered

options Object

The configuration options for the captcha

Name Type Attributes Default Description
templates Object <optional>

An object containaing templates for each captcha provider

Name Type Attributes Description
auth0 function <optional>

template function receiving the challenge and returning an string

recaptcha_v2 function <optional>

template function receiving the challenge and returning an string

lang String <optional>
en

the ISO code of the language for recaptcha

callback function <optional>

An optional completion callback