Class Authentication

constructor

• new Authentication(client, clientAuth, logger): Authentication

• Creates a new authentication instance to authenticate against the CFTools (Data) API.

  Parameters

  • client: CFToolsClient

    The CFTools client instance.
  • clientAuth: ClientAuthenticationData

    The client authentication data.
  • logger: AbstractLogger

    The logger instance.

  Returns Authentication

applicationId

applicationSecret

authenticated

authenticationToken

OptionalenterpriseToken

expiresAt

issuedAt

refreshTimeout

OptionalserverApiId

userAgent

currentToken

• currentToken(): ClientAuthentication

• Returns the current authentication token.

  Returns ClientAuthentication

  The current authentication token.

  Throws

  Thrown if the client is not authenticated.

getAuthenticationBody

• getAuthenticationBody(): {
      application_id: string;
      secret: string;
  }

• Returns {
      application_id: string;
      secret: string;
  }

  The body required for authenticating with the CFTools API.

  • application_id: string

  • secret: string

getHeaders

• getHeaders(isAuthenticating?): AuthHeaders

• Returns the headers required for making requests to the CFTools API.

  Parameters

  • isAuthenticating: boolean = false

    Whether the headers are for an authentication request.

  Returns AuthHeaders

  The headers required for making requests to the CFTools API.

  Throws

  Thrown if the client is not authenticated.

isExpired

• isExpired(): boolean

• Returns boolean

  Whether the authentication token has expired.

isRefreshing

• isRefreshing(): boolean

• Returns boolean

  Whether the authentication token is currently refreshing.

performRefresh

• performRefresh(): Promise<void>

• Refreshes the authentication token.

  Returns Promise<void>

  A promise that resolves when the authentication token has been refreshed.

  Throws

  Thrown if the authentication token has expired.

  Throws

  Thrown if the client is not authenticated.

  Throws

  Thrown if the server API ID is required but missing.

  Throws

  Thrown if the authentication token could not be refreshed.

resolveServerApiId

• resolveServerApiId(serverApiId?, require?): null | string

• Resolves the server API ID to use for an action.

  Parameters

  • OptionalserverApiId: string

    The server API ID to use.
  • Optionalrequire: false

    Whether the server API ID is required or not.

  Returns null | string

  The resolved server API ID.

  Throws

  Thrown if the server API ID is required but missing.

• resolveServerApiId(serverApiId?, require?): string

• Parameters

  • OptionalserverApiId: string
  • Optionalrequire: true

  Returns string

setRefreshing

• setRefreshing(refreshing): void

• Sets the authentication token refreshing state.

  Parameters

  • refreshing: boolean

    Whether the authentication token is refreshing.

  Returns void

shouldRefresh

• shouldRefresh(): boolean

• Returns boolean

  Whether the authentication token should be refreshed.

throwExpired

• throwExpired(): void

• Throws an error if the authentication token has expired.

  Returns void

  Throws

  Thrown if the authentication token has expired.