core.client.disablepolicy.md

Home > @cerbos/core > Client > disablePolicy

Client.disablePolicy() method

Disable a policy.

Signature:

disablePolicy(id: string, options?: RequestOptions): Promise<boolean>;

Parameters

Parameter	Type	Description
id	string
options	RequestOptions	(Optional)

Returns:

Promise<boolean>

Remarks

Requires

• the client to be configured with Options.adminCredentials,

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

• a dynamic storage backend.

Example

const disabled = await cerbos.disablePolicy("resource.document.v1");