Class SelfHostedTokenClient

Hierarchy (View Summary)

LfApiClientCore.BaseTokenClient
- SelfHostedTokenClient

Implements

LfApiClientCore.ISelfHostedTokenClient

Index

Constructors

Properties

Methods

createAccessToken getAccessTokenFromCode getPostRequestHeaders objToWWWFormUrlEncodedBody refreshAccessToken

Constructors

constructor

new SelfHostedTokenClient(
baseUrl: string,
): LfApiClientCore.SelfHostedTokenClient
Constructor for a TokenClient used to interact with the Laserfiche Self-Hosted token endpoint.
Parameters
- baseUrl: string
  APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
Returns LfApiClientCore.SelfHostedTokenClient
Overrides BaseTokenClient.constructor
- Defined in packages/lf-api-client-core-js/dist/lib/APIServer/TokenClient.d.ts:19

Properties

`Protected`_baseUrl

_baseUrl: string

Methods

createAccessToken

createAccessToken(
repositoryId: string,
body: LfApiClientCore.CreateConnectionRequest,
): Promise<LfApiClientCore.SessionKeyInfo>
Gets the Laserfiche Self-Hosted access token
Parameters
- repositoryId: string
  Repository name
- body: LfApiClientCore.CreateConnectionRequest
  Request body that contains username, password and grant type
Returns Promise<LfApiClientCore.SessionKeyInfo>
Create an access token successfully.
Implementation of ISelfHostedTokenClient.createAccessToken
- Defined in packages/lf-api-client-core-js/dist/lib/APIServer/TokenClient.d.ts:20

getAccessTokenFromCode

getAccessTokenFromCode(
    code: string,
    redirect_uri: string,
    client_id?: string,
    client_secret?: string,
    code_verifier?: string,
    scope?: string,
): Promise<LfApiClientCore.GetAccessTokenResponse>
Gets an OAuth access token given an OAuth code
Parameters
- code: string
  Authorization code
- redirect_uri: string
  Authorization endpoint redirect uri
- Optionalclient_id: string
  OPTIONAL 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>
Inherited from BaseTokenClient.getAccessTokenFromCode
- Defined in packages/lf-api-client-core-js/dist/lib/BaseTokenClient.d.ts:34

`Protected`getPostRequestHeaders

getPostRequestHeaders(
client_id?: string,
client_secret?: string,
): Record<string, string>
Parameters
- Optionalclient_id: string
- Optionalclient_secret: string
Returns Record<string, string>
Inherited from BaseTokenClient.getPostRequestHeaders
- Defined in packages/lf-api-client-core-js/dist/lib/BaseTokenClient.d.ts:44

`Protected`objToWWWFormUrlEncodedBody

objToWWWFormUrlEncodedBody(obj: any): string
Parameters
- obj: any
Returns string
Inherited from BaseTokenClient.objToWWWFormUrlEncodedBody
- Defined in packages/lf-api-client-core-js/dist/lib/BaseTokenClient.d.ts:45

refreshAccessToken

refreshAccessToken(
    refresh_token: string,
    client_id?: string,
    client_secret?: string,
): Promise<LfApiClientCore.GetAccessTokenResponse>
Gets a refreshed access token given a refresh token
Parameters
- refresh_token: string
  Refresh token
- Optionalclient_id: string
  OPTIONAL OAuth application client id
- Optionalclient_secret: string
  OPTIONAL OAuth application client secret. Required for web apps.
Returns Promise<LfApiClientCore.GetAccessTokenResponse>
Inherited from BaseTokenClient.refreshAccessToken
- Defined in packages/lf-api-client-core-js/dist/lib/BaseTokenClient.d.ts:41