Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RenewAuthOptions

Hierarchy

  • RenewAuthOptions

Index

Properties

Optional audience

audience: string

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

Optional clientID

clientID: string

your Auth0 client identifier obtained when creating the client in the Auth0 Dashboard

Optional domain

domain: string

your Auth0 domain

Optional nonce

nonce: string

value used to mitigate replay attacks when using Implicit Grant. https://auth0.com/docs/api-auth/tutorials/nonce

Optional postMessageDataType

postMessageDataType: string

identifier data type to look for in postMessage event data, where events are initiated from silent callback urls, before accepting a message event is the event expected. A value of false means any postMessage event will trigger a callback.

Optional postMessageOrigin

postMessageOrigin: string

origin of redirectUri to expect postMessage response from. Defaults to the origin of the receiving window. Only used if usePostMessage is truthy.

Optional redirectUri

redirectUri: string

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

Optional responseMode

responseMode: string

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

Optional responseType

responseType: string

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

Optional scope

scope: string

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

Optional state

state: string

value used to mitigate XSRF attacks. https://auth0.com/docs/protocols/oauth2/oauth-state

Optional timeout

timeout: number

value in milliseconds used to timeout when the /authorize call is failing as part of the silent authentication with postmessage enabled due to a configuration.

Optional usePostMessage

usePostMessage: boolean

use postMessage to communicate between the silent callback and the SPA. When false the SDK will attempt to parse the url hash should ignore the url hash and no extra behaviour is needed

default

false

Generated using TypeDoc