Options
All
  • Public
  • Public/Protected
  • All
Menu

Contains options for OAuth API.

Usually, it is enough to specify your client_id and your redirect_uri registered for your application. Appropriate defaults are set for the remaining parameters, though they can be set by your application if necessary.

For more information about the properties, please refer to: https://login.pcon-solutions.com/doc/api/oauth2.html

Hierarchy

  • OAuthOptions

Index

Properties

client_id

client_id: string

The registered client id for the application

Optional force_login

force_login: undefined | boolean

Set this parameter to true, if you want to force the user to login again

Optional persist_tokens

persist_tokens: undefined | boolean

Set to true to persist tokens in localStorage

redirect_uri

redirect_uri: string

URL that should be redirected to on success

Optional refresh_token_app_infos

refresh_token_app_infos: undefined | string

Provide text that helps identify where this token originated from/is used (e.g. a hostname/useragent )

Optional scope

scope: undefined | string

Space delimited list of required scopes

Optional want_refresh_token

want_refresh_token: undefined | boolean

Set to 1 to indicate the application wants to use refresh tokens, 0 if not

Generated using TypeDoc