Class OAuth2Client

Implements

OAuthClientInterface

Index

Constructors

Methods

deleteAccessToken getAccessToken getError getSessionIframe getStatus getTokenExpiration login loginWithCredentials logout refreshToken requestAuthCode requestTokenWithAuthCode setAccessToken subscribe unsubscribe

Constructors

constructor

new OAuth2Client(config: OAuthClientOptions): OAuth2Client
Parameters
- config: OAuthClientOptions
Returns OAuth2Client
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:37

Methods

deleteAccessToken

deleteAccessToken(): void
Returns void
Implementation of OAuthClientInterface.deleteAccessToken
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:141

getAccessToken

getAccessToken(): null | string
Returns null | string
Implementation of OAuthClientInterface.getAccessToken
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:125

getError

getError(): null | AuthError
Returns null | AuthError
Implementation of OAuthClientInterface.getError
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:117

getSessionIframe

getSessionIframe(): null | OAuth2Iframe
Returns null | OAuth2Iframe
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:396

getStatus

getStatus(): OAuthStatus
Returns OAuthStatus
Implementation of OAuthClientInterface.getStatus
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:121

getTokenExpiration

getTokenExpiration(): number
Returns number
Implementation of OAuthClientInterface.getTokenExpiration
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:150

login(loginRedirectUri?: string): Promise<void>
Authorization code + PKCE Step 1: request one-time authorization code
Parameters
- OptionalloginRedirectUri: string
Returns Promise<void>
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:166

loginWithCredentials

loginWithCredentials(
__namedParameters: { password: string; username: string },
): Promise<AuthError | OAuthData>
Parameters
- __namedParameters: { password: string; username: string }
Returns Promise<AuthError | OAuthData>
Deprecated
loginWithCredentials will be removed in the next major version
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:214

logout

logout(): Promise<void>
Returns Promise<void>
Implementation of OAuthClientInterface.logout
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:252

refreshToken

refreshToken(): Promise<AuthError | OAuthData>
Refresh token

Returns Promise<AuthError | OAuthData>
Implementation of OAuthClientInterface.refreshToken
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:238

requestAuthCode

requestAuthCode(): Promise<void>
Returns Promise<void>
Deprecated
Use login(redirectUrl: string | undefined) instead
Implementation of OAuthClientInterface.requestAuthCode
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:158

requestTokenWithAuthCode

requestTokenWithAuthCode(): Promise<AuthError | OAuthData>
Exchange one-time authorization code for access token

Returns Promise<AuthError | OAuthData>
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:193

setAccessToken

setAccessToken(token?: string): boolean
Parameters
- Optionaltoken: string
Returns boolean
Deprecated
since version 2.5.0
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:130

subscribe(observer: OAuthClientObserver): () => void
Parameters
- observer: OAuthClientObserver
Returns () => void
Implementation of OAuthClientInterface.subscribe
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:101

unsubscribe

unsubscribe(observer: OAuthClientObserver): void
Parameters
- observer: OAuthClientObserver
Returns void
Implementation of OAuthClientInterface.unsubscribe
- Defined in packages/ux-utils/src/authClient/OAuth2Client.ts:110