@egain/ai-agent-sdk API Reference - v0.3.2 / PKCEAuthConfig
Interface: PKCEAuthConfig
Configuration for PKCE authentication strategy
Table of contents
Properties
- authorizationUrl
- tokenUrl
- clientId
- redirectUri
- scopes
- authScheme
- cacheLocation
- knownAuthorities
- authorityMetadata
- nextRoute
- localLogin
Properties
authorizationUrl
• Optional authorizationUrl: string
Authorization server URL (authority)
Defined in
core/auth/PKCEAuthStrategy.ts:28
tokenUrl
• Optional tokenUrl: string
Token endpoint URL (not used directly by MSAL, but kept for compatibility)
Defined in
core/auth/PKCEAuthStrategy.ts:33
clientId
• clientId: string
Client ID
Defined in
core/auth/PKCEAuthStrategy.ts:38
redirectUri
• redirectUri: string
Redirect URI for OAuth callback
Defined in
core/auth/PKCEAuthStrategy.ts:43
scopes
• Optional scopes: string[]
Optional scopes to request
Defined in
core/auth/PKCEAuthStrategy.ts:48
authScheme
• Optional authScheme: "popup" | "redirect"
Authentication scheme: 'popup' or 'redirect'. Login and logout use the same scheme.
Default
'redirect'Defined in
core/auth/PKCEAuthStrategy.ts:54
cacheLocation
• Optional cacheLocation: "localStorage" | "sessionStorage"
Cache location: 'localStorage' or 'sessionStorage'
Default
'sessionStorage'Defined in
core/auth/PKCEAuthStrategy.ts:60
knownAuthorities
• knownAuthorities: string[]
Known authorities
Defined in
core/auth/PKCEAuthStrategy.ts:65
authorityMetadata
• Optional authorityMetadata: string
Authority metadata
Defined in
core/auth/PKCEAuthStrategy.ts:70
nextRoute
• Optional nextRoute: string
Return URL after redirect login or logout (OAuth state). Hash is stripped before it is sent. Popup omits state so auth-redirect.html does not bounce the popup to the app. Redirect logout uses this, else window.location.href.
Defined in
core/auth/PKCEAuthStrategy.ts:77
localLogin
• Optional localLogin: boolean
When true, forces local account login instead of federated SSO.