Interface BaseCredentialRefresher

Base interface for credential refreshers.

Credential refreshers are responsible for checking if a credential is expired or needs to be refreshed, and for refreshing it if necessary.

interface BaseCredentialRefresher {
    isRefreshNeeded(
        authCredential: AuthCredential,
        authScheme?: AuthScheme,
    ): Promise<boolean>;
    refresh(
        authCredential: AuthCredential,
        authScheme?: AuthScheme,
    ): Promise<AuthCredential>;
}

Methods

isRefreshNeeded

isRefreshNeeded(
authCredential: AuthCredential,
authScheme?: AuthScheme,
): Promise<boolean>
Checks if a credential needs to be refreshed.
Parameters
- authCredential: AuthCredential
  The credential to check.
- OptionalauthScheme: AuthScheme
  The authentication scheme (optional).
Returns Promise<boolean>
True if the credential needs to be refreshed, False otherwise.
- Defined in core/src/auth/refresher/base_credential_refresher.ts:34

refresh

refresh(
authCredential: AuthCredential,
authScheme?: AuthScheme,
): Promise<AuthCredential>
Refreshes a credential if needed.
Parameters
- authCredential: AuthCredential
  The credential to refresh.
- OptionalauthScheme: AuthScheme
  The authentication scheme (optional).
Returns Promise<AuthCredential>
The refreshed credential.

Throws
If credential refresh fails.
- Defined in core/src/auth/refresher/base_credential_refresher.ts:47