Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProvisioningApi

The provisioning API serves two classes of clients:

  • Integration managers which provide a unique secret token, and a userId
  • Widget users which provide a openId token.

Hierarchy

  • ProvisioningApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected baseRoute

baseRoute: Router

Protected store

store: ProvisioningStore

Methods

addRoute

  • addRoute(method: "get" | "post" | "delete" | "put", path: string, handler: (req: ProvisioningRequest<Record<string, unknown>, Record<string, unknown>>, res: Response<any, Record<string, any>>, next?: NextFunction) => void | Promise<void>, fnName?: string): void

  • Parameters

    • method: "get" | "post" | "delete" | "put"
    • path: string
    • handler: (req: ProvisioningRequest<Record<string, unknown>, Record<string, unknown>>, res: Response<any, Record<string, any>>, next?: NextFunction) => void | Promise<void>
        • (req: ProvisioningRequest<Record<string, unknown>, Record<string, unknown>>, res: Response<any, Record<string, any>>, next?: NextFunction): void | Promise<void>

        • Parameters

          • req: ProvisioningRequest<Record<string, unknown>, Record<string, unknown>>
          • res: Response<any, Record<string, any>>
          • Optional next: NextFunction

          Returns void | Promise<void>

    • Optional fnName: string

    Returns void

close

  • close(): Promise<void>

start

  • start(port: number, hostname?: string, backlog?: number): Promise<void>

Generated using TypeDoc