Class ClientCredentialsProvider

OAuth2 client-credentials provider. Construct via clientCredentials.

Index

Constructors

Methods

getCredentials on signOut

Constructors

constructor

new ClientCredentialsProvider(config): ClientCredentialsProvider
Parameters
- config: ClientCredentialsConfig
Returns ClientCredentialsProvider
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/auth/client-credentials-provider.ts:41

Methods

getCredentials

getCredentials(context?): Promise<undefined | HonuaAuthCredentials>
HonuaAuthProvider.getCredentials: fetch/refresh a bearer token.
Parameters
- context: HonuaAuthProviderContext = ...
Returns Promise<undefined | HonuaAuthCredentials>
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/auth/client-credentials-provider.ts:53

on

on(listener): {
remove(): void;
}
Parameters
- listener: HonuaAuthEventListener
Returns {
remove(): void;
}
- remove:function
  - remove(): void
  - Returns void
    - Defined in work/honua-sdk-js/honua-sdk-js/src/core/auth/client-credentials-provider.ts:71
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/auth/client-credentials-provider.ts:71

signOut

signOut(): Promise<void>
Drop the cached token; the next call re-requests the grant.

Returns Promise<void>
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/auth/client-credentials-provider.ts:65