Entity - Policies

Minimum API version 4.0

VerbRequestNotesPermissions required
GET/Consumer/Policies/{id}Returns a single policy by its IdRequires 'Read' permission on 'GuaranteedState' securable type
GET/Consumer/Policies/Pending/ChangesReturns information on whether policies have pending changesRequires 'Execute' permission on 'PolicyDeployment' securable type
GET/Consumer/PoliciesReturns all policiesRequires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Policies/Search

Returns Policies that match the search parameters specified

Allowed filter columns:

  • Name
  • Description
  • Enabled

Allowed sort columns:

  • Name
  • Description
  • Enabled
Requires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Policies/ShallowSearch

Returns Policies that match the search parameters specified.

This endpoint returns Ids of rules instead of entire objects and Management Group names instead of entire objects.

Allowed filter columns:

  • Name
  • Description
  • Enabled

Allowed sort columns:

  • Name
  • Description
  • Enabled
Requires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/PoliciesCreates a new policyRequires 'Write' permission on 'GuaranteedState' securable type
POST/Consumer/Policies/{id}/Rules

Adds given Rules to a specific policy and returns updated policy.

Rule Ids should be passed in as an array of integers in the body of the request.

Requires 'Write' permission on 'GuaranteedState' securable type
DELETE/Consumer/Policies/{id}/RulesRemoves all rules from a given policy and returns updated policy.Requires 'Delete' permission on 'GuaranteedState' securable type
DELETE/Consumer/"Policies/{id}/Rules/{ruleId}Removes a specific Rule from a given policy and returns updated policy.Requires 'Delete' permission on 'GuaranteedState' securable type
PUT/Consumer/PoliciesUpdates and existing policy and returns updated policy.Requires 'Write' permission on 'GuaranteedState' securable type
DELETE/Consumer/Policies/{id}Deletes a policyRequires 'Delete' permission on 'GuaranteedState' securable type
POST/Consumer/Policies/{id}/Enable/{enable}

Enables a policy if 'enable' parameter is set to 'true' or disables a policy if 'enable' parameter is set to 'false'.

Requires 'Write' permission on 'GuaranteedState' securable type
POST/Consumer/Policies/{id}/Assignments

Assigns a Policy to selected Management groups.

Management Groups Ids should be passed in as an array of integers in the body of the request.

Requires 'Write' permission on 'GuaranteedState' securable type
PUT/Consumer/Policies/{id}/Assignments

Replaces all Management Groups assigned to a given policy with Management Groups supplied in this request.

Management Groups Ids should be passed in as an array of integers in the body of the request.

Requires 'Write' permission on 'GuaranteedState' securable type
GET/Consumer/Policies/{id}/AssignmentsReturns Management groups assigned to given PolicyRequires 'Read' permission on 'GuaranteedState' securable type
DELETE/Consumer/Policies/{id}/AssignmentsRemoves all Management Groups from given policyRequires 'Delete' permission on 'GuaranteedState' securable type
DELETE/Consumer/Policies/{id}/Assignments/ManagementGroups/{managementGroupId}Removes specific Management Group from given policyRequires 'Delete' permission on 'GuaranteedState' securable type
GET/Consumer/Policies/Unlicensed

Minimum API version 5.1

Returns a list of Ids of Policies that use unlicensed Fragments

Requires 'Read' permission on 'GuaranteedState' securable type