core.client.getpolicy.md

Home > @cerbos/core > Client > getPolicy

Client.getPolicy() method

Fetch a policy by ID.

Signature:

getPolicy(id: string, options?: RequestOptions): Promise<Policy | undefined>;

Parameters

Parameter	Type	Description
id	string
options	RequestOptions	(Optional)

Returns:

Promise<Policy | undefined>

Remarks

Requires

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

• the Cerbos policy decision point server to be configured with the admin API enabled.

Example

const policy = await cerbos.getPolicy("resource.document.v1");