Override Policy

Manage policies that override default behavior.

📄️Create an override policy

Creates an override policy and returns it with its new ID. The name must not match the name of an existing override policy.

📄️Add credentials to an override policy

Adds the listed credentials to a credential override policy, then applies the policy's rotation and verification schedules to them. A credential counts as failed when it is not on the policy's platform, already belongs to any override policy, or could not be added.

📄️List credentials that can be added to a policy

Returns a page of credentials that you can add to a credential override policy: managed credentials on the policy's platform that are set to rotate automatically and do not already belong to any override policy. Use it to build a picker before you add credentials to the policy.

📄️Remove credentials from an override policy

Removes the listed credentials from a credential override policy and reverts the policy's rotation and verification jobs for them. IDs that are not members of this policy count as failed. The list must contain at least one ID.

📄️Search credentials in a policy

Returns a page of the credentials in a credential override policy, sorted by the search parameters. Only managed credentials that are set to rotate automatically are listed. The policy must be a credential override policy.

📄️List override policy names and IDs

Returns the name and ID of each override policy of the given type, sorted by name. Use it to fill a selection list. The type defaults to credential policies.

📄️Delete an override policy

Deletes one credential override policy. Credentials in the policy are removed from it first, and the policy's password rotation and verification jobs for those credentials are reverted.

📄️Get an override policy

Returns one override policy, including its scan, protect, rotate and verify schedules.

📄️Update an override policy

Replaces the settings of an override policy and returns the updated policy. Send the full policy: the ID in the body must match the ID in the path, and the name must not match another policy. When a schedule ID changes, the policy's existing jobs of that kind move to the new schedule.