Class ClientCredentials

An Authenticator class for the OAuth 2.0 Client Credentials grant.

Hierarchy

Constructors

constructor

Properties

_accessToken? _authInProgress _expires? authServer baseUrl clientId clientSecret

Accessors

accessToken

Methods

fetchAccessToken setAccessToken

Constructors

constructor

Properties

Optional _accessToken

_accessToken?: string

_authInProgress

_authInProgress: boolean = true

Optional _expires

_expires?: number

Private authServer

authServer: string = DEFAULT_AUTH_SERVER

Private baseUrl

baseUrl: string = DEFAULT_BASE_URL

Private clientId

clientId: string

Private clientSecret

clientSecret: string

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>

Methods

fetchAccessToken

  • This method fetches an access token using the OAuth 2.0 Client Credentials grant and returns it

    Returns Promise<{
        accessToken: string;
        expiresIn: number;
    }>

setAccessToken

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc