Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

  • getAccountIdFromLfJWT(lfJwt: JWT): string
  • Returns Laserfiche account id (customer id) from Laserfiche jwt claims

    example
    const jwt : AccessTokenUtils.JWT = {
    header: { 'typ': 'JWT'},
    payload: {'csid' : '123456789'},
    signature: '_signature'
    }
    getAccountIdFromLfJWT(jwt); // '123456789';

    Parameters

    Returns string

  • getLfDevEnvironmentSubDomain(urlHostName: string): string
  • Returns the Laserfiche Cloud dev environment subDomain associated with the provided host name

    example
    getLfDevEnvironmentSubDomain('a.clouddev.laserfiche.ca'); // 'a.clouddev'
    getLfDevEnvironmentSubDomain('cloudtest.laserfiche.com'); // 'cloudtest'
    getLfDevEnvironmentSubDomain('laserfiche.com'); // ''

    Parameters

    • urlHostName: string

    Returns string

  • getLfEndpoints(accountId: string, devEnvironmentSubDomain?: string): LfEndpoints
  • Returns region-specific Laserfiche Cloud endpoints

    example
    getLfEndpoints('123456789', 'a.clouddev');
    // => {
    // webClientUrl: 'https://app.a.clouddev.laserfiche.com/laserfiche',
    // wsignoutUrl: 'https://accounts.a.clouddev.laserfiche.com/WebSTS/?wa=wsignout1.0',
    // repositoryApiBaseUrl: 'https://api.a.clouddev.laserfiche.com/repository/'
    // }

    getLfEndpoints('123456789');
    // => {
    // webClientUrl: 'https://app.laserfiche.com/laserfiche',
    // wsignoutUrl: 'https://accounts.laserfiche.com/WebSTS/?wa=wsignout1.0',
    // repositoryApiBaseUrl: 'https://api.laserfiche.com/repository/'
    // }

    Parameters

    • accountId: string
    • Optional devEnvironmentSubDomain: string

      optional dev environment subDomain, such as 'a.clouddev', or 'cloudtest'

    Returns LfEndpoints

  • getLfRegionalDomainFromAccountId(accountId: string, devEnvironmentSubDomain?: string): string
  • Returns the Laserfiche regional cloud domains given an account id

    example
    getLfRegionalDomainFromAccountId('1123456789'); // 'laserfiche.ca'
    getLfRegionalDomainFromAccountId('1123456789', 'a.clouddev'); // 'a.clouddev.laserfiche.ca'
    getLfRegionalDomainFromAccountId('123456789', 'a.clouddev'); // 'a.clouddev.laserfiche.com'
    getLfRegionalDomainFromAccountId('2123456789', 'cloudtest'); // 'cloudtest.eu.laserfiche.com'

    Parameters

    • accountId: string
    • Optional devEnvironmentSubDomain: string

      optional dev environment subDomain, such as 'a.clouddev', or 'cloudtest'

    Returns string

  • getTrusteeIdFromLfJWT(lfJwt: JWT): string
  • Returns Laserfiche trustee id (user id) from Laserfiche jwt claims

    example
    const jwt : AccessTokenUtils.JWT = {
    header: { 'typ': 'JWT'},
    payload: {'trid' : '1008'},
    signature: '_signature'
    }
    getTrusteeIdFromLfJWT(jwt); // '1008';

    Parameters

    Returns string

  • parseAccessToken(jwt: string): JWT
  • Parses a base64-encoded jwt

    example
    const jwtString = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
    parseAccessToken(jstString);
    // => {
    header:
    {
    'alg': 'HS256',
    'typ': 'JWT'
    },
    payload:
    {
    'sub': '1234567890',
    'name': 'John Doe',
    'iat': 1516239022
    },
    signature: 'SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }

    Parameters

    • jwt: string

    Returns JWT

Generated using TypeDoc