Interface AppClient

Readonlyapi

anchorTuple

• anchorTuple(objectType: string, objectId: string, companyId: string): Tuple

  The company_module anchor tuple binding an object of the app to a company.

  Parameters

  • objectType: string
  • objectId: string
  • companyId: string

  Returns Tuple

can

• can(
      userBearer: string,
      request: EffectiveAccessRequest,
  ): Promise<EffectiveAccessDecision>

  Asks Kiban whether the user behind userBearer may use a feature (Kiban answers for that bearer only). Pass the bearer the user presented to the app, unchanged.

  Parameters

  • userBearer: string
  • request: EffectiveAccessRequest

  Returns Promise<EffectiveAccessDecision>

canService

• canService(request: EffectiveAccessRequest): Promise<EffectiveAccessDecision>

  Asks for the app's own service account (a background job).

  Parameters

  • request: EffectiveAccessRequest

  Returns Promise<EffectiveAccessDecision>

grant

• grant(companyId: string, tuples: Tuple[]): Promise<void>

  Writes tuples on the app's own object types in a company. Every object must carry its anchor (AppClient.anchorTuple) in the same or an earlier call.

  Parameters

  • companyId: string
  • tuples: Tuple[]

  Returns Promise<void>

memberBySubject

• memberBySubject(companyId: string, subject: string): Promise<MemberFact>

  Asks org whether a subject is an active member of a company.

  Parameters

  • companyId: string
  • subject: string

  Returns Promise<MemberFact>

registerApp

• registerApp(superadminBearer: string, manifest: AppManifest): Promise<void>

  Registers (or re-registers) the app with a superadmin's bearer.

  Parameters

  • superadminBearer: string
  • manifest: AppManifest

  Returns Promise<void>

revoke

• revoke(companyId: string, tuples: Tuple[]): Promise<void>

  Removes tuples the app wrote.

  Parameters

  • companyId: string
  • tuples: Tuple[]

  Returns Promise<void>