@okta/okta-auth-js/myaccount / Exports / OktaAuthMyAccountInterface
| Name | Type |
|---|---|
M |
extends OAuthTransactionMeta = PKCETransactionMeta |
S |
extends OAuthStorageManagerInterface<M> = OAuthStorageManagerInterface<M> |
O |
extends OktaAuthOAuthOptions = OktaAuthOAuthOptions |
-
OktaAuthOAuthInterface<M,S,O>↳
OktaAuthMyAccountInterface
- _oktaUserAgent
- emitter
- features
- http
- myaccount
- options
- pkce
- session
- storageManager
- token
- tokenManager
- transactionManager
- clearStorage
- closeSession
- getAccessToken
- getIdToken
- getIssuerOrigin
- getOriginalUri
- getRefreshToken
- getUser
- isAuthenticated
- isLoginRedirect
- isPKCE
- removeOriginalUri
- revokeAccessToken
- revokeRefreshToken
- setHeaders
- setOriginalUri
- signInWithRedirect
- signOut
- storeTokensFromRedirect
- webfinger
• _oktaUserAgent: OktaUserAgent
OktaAuthOAuthInterface._oktaUserAgent
• emitter: EventEmitter
OktaAuthOAuthInterface.emitter
• features: FeaturesAPI
OktaAuthOAuthInterface.features
• http: HttpAPI
OktaAuthOAuthInterface.http
• myaccount: any
• options: O
OktaAuthOAuthInterface.options
• pkce: PkceAPI
OktaAuthOAuthInterface.pkce
• session: SessionAPI
OktaAuthOAuthInterface.session
• storageManager: S
OktaAuthOAuthInterface.storageManager
• token: TokenAPI
OktaAuthOAuthInterface.token
• tokenManager: TokenManagerInterface
OktaAuthOAuthInterface.tokenManager
• transactionManager: TransactionManagerInterface
OktaAuthOAuthInterface.transactionManager
▸ clearStorage(): void
void
OktaAuthOAuthInterface.clearStorage
▸ closeSession(): Promise<boolean>
Promise<boolean>
OktaAuthOAuthInterface.closeSession
▸ getAccessToken(): undefined | string
undefined | string
OktaAuthOAuthInterface.getAccessToken
▸ getIdToken(): undefined | string
undefined | string
OktaAuthOAuthInterface.getIdToken
▸ getIssuerOrigin(): string
string
OktaAuthOAuthInterface.getIssuerOrigin
▸ getOriginalUri(state?): undefined | string
| Name | Type |
|---|---|
state? |
string |
undefined | string
OktaAuthOAuthInterface.getOriginalUri
▸ getRefreshToken(): undefined | string
undefined | string
OktaAuthOAuthInterface.getRefreshToken
▸ getUser<T>(): Promise<UserClaims<T>>
| Name | Type |
|---|---|
T |
extends CustomUserClaims = CustomUserClaims |
Promise<UserClaims<T>>
OktaAuthOAuthInterface.getUser
▸ isAuthenticated(options?): Promise<boolean>
| Name | Type |
|---|---|
options? |
IsAuthenticatedOptions |
Promise<boolean>
OktaAuthOAuthInterface.isAuthenticated
▸ isLoginRedirect(): boolean
boolean
OktaAuthOAuthInterface.isLoginRedirect
▸ isPKCE(): boolean
boolean
OktaAuthOAuthInterface.isPKCE
▸ removeOriginalUri(state?): void
| Name | Type |
|---|---|
state? |
string |
void
OktaAuthOAuthInterface.removeOriginalUri
▸ revokeAccessToken(accessToken?): Promise<unknown>
| Name | Type |
|---|---|
accessToken? |
AccessToken |
Promise<unknown>
OktaAuthOAuthInterface.revokeAccessToken
▸ revokeRefreshToken(refreshToken?): Promise<unknown>
| Name | Type |
|---|---|
refreshToken? |
RefreshToken |
Promise<unknown>
OktaAuthOAuthInterface.revokeRefreshToken
▸ setHeaders(headers): void
| Name | Type |
|---|---|
headers |
any |
void
OktaAuthOAuthInterface.setHeaders
▸ setOriginalUri(originalUri, state?): void
| Name | Type |
|---|---|
originalUri |
string |
state? |
string |
void
OktaAuthOAuthInterface.setOriginalUri
▸ signInWithRedirect(opts?): Promise<void>
| Name | Type |
|---|---|
opts? |
SigninWithRedirectOptions |
Promise<void>
OktaAuthOAuthInterface.signInWithRedirect
▸ signOut(opts?): Promise<boolean>
| Name | Type |
|---|---|
opts? |
SignoutOptions |
Promise<boolean>
OktaAuthOAuthInterface.signOut
▸ storeTokensFromRedirect(): Promise<void>
Promise<void>
OktaAuthOAuthInterface.storeTokensFromRedirect
▸ webfinger(opts): Promise<object>
| Name | Type |
|---|---|
opts |
any |
Promise<object>
OktaAuthOAuthInterface.webfinger