AuthorizeOptions
@authgear/web / AuthorizeOptions
Interface: AuthorizeOptions
Auth UI authorization options
Table of contents
Properties
Properties
loginHint
• Optional loginHint: string
OIDC login hint parameter
Defined in
packages/authgear-web/index.d.ts:252
page
• Optional page: string
Initial page to open. Valid values are 'login' and 'signup'.
Defined in
packages/authgear-web/index.d.ts:264
prompt
• Optional prompt: PromptOption | PromptOption[]
OIDC prompt parameter.
Prompt parameter will be used for Authgear authorization, it will also be forwarded to the underlying SSO providers.
For Authgear, currently, only login is supported. Other unsupported values will be ignored.
For the underlying SSO providers, some providers only support a single value rather than a list. The first supported value will be used for that case. e.g. Azure Active Directory
Defined in
packages/authgear-web/index.d.ts:248
redirectURI
• redirectURI: string
Redirect uri. Redirection URI to which the response will be sent after authorization.
Defined in
packages/authgear-web/index.d.ts:231
responseType
• Optional responseType: "none" | "code"
OAuth response type
Defined in
packages/authgear-web/index.d.ts:260
state
• Optional state: string
OAuth 2.0 state value.
Defined in
packages/authgear-web/index.d.ts:235
uiLocales
• Optional uiLocales: string[]
UI locale tags
Defined in
packages/authgear-web/index.d.ts:256