Skip to main content

Update an access policy

PUT 
/api/v1/AccessControlPolicy/:accessControlPolicyId

Updates the settings of an access policy and returns the updated policy. The id in the body must match the id in the path, and the name must stay unique. The settings you send replace the stored values. The member lists in the body only add members; change membership with the add and remove routes.

Permission required: Administrator, application, or a custom role with the Modify Name, Modify Description or Modify Connection Profile permission on this policy.

Values for policyType: 0 = Resource, 1 = Credential.

Caution: Settings left out of the body are reset: the description is cleared, the priority becomes 0 and the policy type becomes Resource. The update also clears the disabled and deleted flags, and removes members that do not fit the policy type: a Resource policy loses its credentials, secret vaults and Credential Release and File Release activities; a Credential policy loses its resource groups, its resources other than secret vaults, its activity groups and its activities other than Credential Release and File Release. Members listed in the body are added before the name is checked, so a request rejected for a duplicate name can still add them. Send every setting you want to keep.

Request​

Responses​

The updated policy. In it, approvalTypeRequired is always 0, notesRequired and ticketRequired are false and activityConfiguration is null; read the connection profile with its own route.