Class TokenClient

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

Implements

LfApiClientCore.ITokenClient

Index

Constructors

Methods

getAccessTokenFromCode getAccessTokenFromServicePrincipal refreshAccessToken

Constructors

constructor

new TokenClient(regionalDomain): LfApiClientCore.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 LfApiClientCore.TokenClient
- Defined in packages/lf-api-client-core-js/dist/lib/OAuth/TokenClient.d.ts:44

Methods

getAccessTokenFromCode

getAccessTokenFromCode(code, redirect_uri, client_id, client_secret?, code_verifier?, scope?): Promise<LfApiClientCore.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<LfApiClientCore.GetAccessTokenResponse>
Implementation of ITokenClient.getAccessTokenFromCode
- Defined in packages/lf-api-client-core-js/dist/lib/OAuth/TokenClient.d.ts:61

getAccessTokenFromServicePrincipal

getAccessTokenFromServicePrincipal(servicePrincipalKey, accessKey, scope?): Promise<LfApiClientCore.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: LfApiClientCore.AccessKey
  OAuth service application access key
- Optionalscope: string
  OPTIONAL The requested space-delimited scopes for the access token.
Returns Promise<LfApiClientCore.GetAccessTokenResponse>
Implementation of ITokenClient.getAccessTokenFromServicePrincipal
- Defined in packages/lf-api-client-core-js/dist/lib/OAuth/TokenClient.d.ts:68

refreshAccessToken

refreshAccessToken(refresh_token, client_id, client_secret?): Promise<LfApiClientCore.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<LfApiClientCore.GetAccessTokenResponse>
Implementation of ITokenClient.refreshAccessToken
- Defined in packages/lf-api-client-core-js/dist/lib/OAuth/TokenClient.d.ts:51