Class ClientCredentials

An Authenticator class for the OAuth 2.0 Client Credentials grant.

Hierarchy (view full)

Authenticator
- ClientCredentials

Index

Constructors

Properties

_accessToken? _authInProgress _expires?

Accessors

Methods

fetchAccessToken setAccessToken

Constructors

constructor

new ClientCredentials(clientId, clientSecret, tokenCache?, authServer?, baseUrl?): ClientCredentials
Parameters
- clientId: string
- clientSecret: string
- OptionaltokenCache: TokenCache
- authServer: string = DEFAULT_AUTH_SERVER
- baseUrl: string = DEFAULT_BASE_URL
Returns ClientCredentials
Overrides Authenticator.constructor
- Defined in authentication/ClientCredentials.ts:12

Properties

`Optional`_accessToken

_accessToken?: string

_authInProgress

_authInProgress: boolean = true

`Optional`_expires

_expires?: number

Accessors

accessToken

get accessToken(): Promise<undefined | string>
Promise that will resolve with an access token if available or undefined otherwise. This will try to fetch a new access token if:
- the class implements the fetchAccessToken method
- no unexpired access token is stored in this class
Returns Promise<undefined | string>
Inherited from Authenticator.accessToken
- Defined in authentication/Authenticator.ts:48

Methods

fetchAccessToken

fetchAccessToken(): Promise<AccessTokenResponse>
This method fetches an access token using the OAuth 2.0 Client Credentials grant and returns it

Returns Promise<AccessTokenResponse>
Overrides Authenticator.fetchAccessToken
- Defined in authentication/ClientCredentials.ts:39

setAccessToken

setAccessToken(accessToken, expiresIn): void
Puts an access token and the expiration time in storage for usage when calling Spinque Query API
Parameters
- accessToken: string
- expiresIn: number
Returns void
Inherited from Authenticator.setAccessToken
- Defined in authentication/Authenticator.ts:74