Class TokenClient

An object to interact with the Laserfiche Cloud OAuth 2.0 token endpoint.

Implements

ITokenClient

Index

Constructors

Methods

getAccessTokenFromCode getAccessTokenFromServicePrincipal refreshAccessToken

Constructors

constructor

new TokenClient(regionalDomain: string): TokenClient
Constructor for a TokenClient used to interact with the Laserfiche Cloud OAuth 2.0 token endpoint.
Parameters
- regionalDomain: string
  regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
Returns TokenClient
- Defined in packages/lf-api-client-core-js/lib/OAuth/TokenClient.ts:69

Methods

getAccessTokenFromCode

getAccessTokenFromCode(
    code: string,
    redirect_uri: string,
    client_id: string,
    client_secret?: string,
    code_verifier?: string,
    scope?: string,
): Promise<GetAccessTokenResponse>
Gets an OAuth access token given an OAuth code
Parameters
- code: string
  Authorization code
- redirect_uri: string
  Authorization endpoint redirect uri
- client_id: string
  OAuth application client id
- Optionalclient_secret: string
  OPTIONAL OAuth application client secret. Required for web apps.
- Optionalcode_verifier: string
  OPTIONAL PKCE code verifier. Required for SPA apps.
- Optionalscope: string
  OPTIONAL The requested space-delimited scopes for the access token.
Returns Promise<GetAccessTokenResponse>
Implementation of ITokenClient.getAccessTokenFromCode
- Defined in packages/lf-api-client-core-js/lib/OAuth/TokenClient.ts:110

getAccessTokenFromServicePrincipal

getAccessTokenFromServicePrincipal(
    servicePrincipalKey: string,
    accessKey: AccessKey,
    scope?: string,
): Promise<GetAccessTokenResponse>
Gets an OAuth access token given a Laserfiche cloud service principal key and an OAuth service application access key.
Parameters
- servicePrincipalKey: string
  Laserfiche cloud service principal key
- accessKey: AccessKey
  OAuth service application access key
- Optionalscope: string
  OPTIONAL The requested space-delimited scopes for the access token.
Returns Promise<GetAccessTokenResponse>
Implementation of ITokenClient.getAccessTokenFromServicePrincipal
- Defined in packages/lf-api-client-core-js/lib/OAuth/TokenClient.ts:148

refreshAccessToken

refreshAccessToken(
    refresh_token: string,
    client_id: string,
    client_secret?: string,
): Promise<GetAccessTokenResponse>
Gets a refreshed access token given a refresh token
Parameters
- refresh_token: string
  Refresh token
- client_id: string
  OAuth application client id
- Optionalclient_secret: string
  OPTIONAL OAuth application client secret. Required for web apps.
Returns Promise<GetAccessTokenResponse>
Implementation of ITokenClient.refreshAccessToken
- Defined in packages/lf-api-client-core-js/lib/OAuth/TokenClient.ts:79