core.client.inspectpolicies.md

Home > @cerbos/core > Client > inspectPolicies

Client.inspectPolicies() method

Inspect policies in the store.

Signature:

inspectPolicies(request?: InspectPoliciesRequest, options?: RequestOptions): Promise<InspectPoliciesResponse>;

Parameters

Parameter	Type	Description
request	InspectPoliciesRequest	(Optional)
options	RequestOptions	(Optional)

Returns:

Promise<InspectPoliciesResponse>

Remarks

Requires

• the client to be configured with Options.adminCredentials; and

• the Cerbos policy decision point server to be at least v0.35 and configured with the admin API enabled.

Example

const { policies } = await cerbos.inspectPolicies();