core.clientwithprincipal.planresources.md

Home > @cerbos/core > ClientWithPrincipal > planResources

ClientWithPrincipal.planResources() method

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.

Signature:

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

Parameters

Parameter	Type	Description
request	Omit<PlanResourcesRequest, "principal">
options	RequestOptions	(Optional)

**Returns:**

Promise<PlanResourcesResponse>