Class ClientWithPrincipal<ClientType>

ReadonlyauxData

Readonlyclient

Readonlyprincipal

checkResource

• checkResource(
      request: Omit<CheckResourceRequest, "principal">,
      options?: RequestOptions,
  ): Promise<CheckResourcesResult>

  Check the principal's permissions on a resource. See Client.checkResource for details.

  Parameters

  • request: Omit<CheckResourceRequest, "principal">
  • Optionaloptions: RequestOptions

  Returns Promise<CheckResourcesResult>

checkResources

• checkResources(
      request: Omit<CheckResourcesRequest, "principal">,
      options?: RequestOptions,
  ): Promise<CheckResourcesResponse>

  Check the principal's permissions on a set of resources. See Client.checkResources for details.

  Parameters

  • request: Omit<CheckResourcesRequest, "principal">
  • Optionaloptions: RequestOptions

  Returns Promise<CheckResourcesResponse>

isAllowed

• isAllowed(
      request: Omit<IsAllowedRequest, "principal">,
      options?: RequestOptions,
  ): Promise<boolean>

  Check if the principal is allowed to perform an action on a resource. See Client.isAllowed for details.

  Parameters

  • request: Omit<IsAllowedRequest, "principal">
  • Optionaloptions: RequestOptions

  Returns Promise<boolean>

planResources

• planResources(
      request: Omit<PlanResourcesRequest, "principal">,
      options?: RequestOptions,
  ): Promise<PlanResourcesResponse>

  Produce a query plan that can be used to obtain a list of resources on which the principal is allowed to perform a particular action. See Client.planResources for details.

  Parameters

  • request: Omit<PlanResourcesRequest, "principal">
  • Optionaloptions: RequestOptions

  Returns Promise<PlanResourcesResponse>