Home Reference Source

Typedef

Static Public Summary
public

The configuration for salte auth
public

The configuration for salte auth
public

Disable certain security validations if your provider doesn't support them.
public

Disable certain security validations if your provider doesn't support them.

Static Public

public Config: Object source

The configuration for salte auth

Properties:

NameTypeAttributeDescription
providerUrl String

The base url of your identity provider.
responseType 'id_token' | 'id_token token' | 'code'

The response type to authenticate with.
redirectUrl String | RedirectURLs

The redirect url specified in your identity provider.
clientId String

The client id of your identity provider
scope String

A list of space-delimited claims used to determine what user information is provided and what access is given. Most providers require 'openid'.
routes Boolean | Array<String>

A list of secured routes. If true is provided then all routes are secured.
endpoints Array<String|RegExp>

A list of secured endpoints.
provider 'auth0' | 'azure' | 'cognito' | 'wso2' | 'okta'

The identity provider you're using.
loginType 'iframe' | 'redirect' | false
  • optional
  • default: 'iframe'

The automated login type to use.
redirectLoginCallback Function
  • optional

A callback that is invoked when a redirect login fails or succeeds.
storageType 'session' | 'local'
  • optional
  • default: 'session'

The Storage api to keep authenticate information stored in.
validation Boolean | Validation
  • optional

Used to disable certain security validations if your provider doesn't support them.
autoRefresh Boolean
  • optional
  • default: true

Automatically refreshes the users token upon switching tabs or one minute prior to expiration.
autoRefreshBuffer Number
  • optional
  • default: 60000

A number of miliseconds before token expiration to refresh.
queryParams Object
  • optional

A key-value set of additional query params to attached to the login request.

public LoginConfig: Object source

The configuration for salte auth

Properties:

NameTypeAttributeDescription
noPrompt Boolean
  • optional
  • default: false

Disables login prompts, this should only be used for token renewal!
clear false | 'errors' | 'all'
  • optional
  • default: 'all'

Whether to clear "all" profile information, only "errors", or nothing.
events Boolean
  • optional
  • default: true

Whether events should be fired off if the login is successful or not.

public RedirectURLs: Object source

Disable certain security validations if your provider doesn't support them.

Properties:

NameTypeAttributeDescription
loginUrl String
  • optional

The redirect url specified in your identity provider for logging in.
logoutUrl String
  • optional

The redirect url specified in your identity provider for logging out.

public Validation: Object source

Disable certain security validations if your provider doesn't support them.

Properties:

NameTypeAttributeDescription
nonce Boolean
  • optional
  • default: true

Passing false will disable nonce validation, leaving you vulnerable to replay attacks.
state Boolean
  • optional
  • default: true

Passing false will disable state validation, leaving you vulnerable to XSRF attacks.
azp Boolean
  • optional
  • default: true

Passing false will disable azp validation.
aud Boolean
  • optional
  • default: true

Passing false will disable aud validation.