Get Assignments

Get Assignments

Returns a paginated list of policy assignments. This can be filtered by policy Ids, target names, policy types, project ID, or assignment phase.

Request
URI
GET
https://{api_host}/policy/api/policyAssignments
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string of array
policyIds
Optional

Matches will only include assignments with this policyIds

string of array
targetIds
Optional

Matches will only include decisions with this target ids

string of array
targetNames
Optional

Matches will only include decisions with this target names

string of array
policyTypeIds
Optional

Matches will only include assignments with this policyTypeIds

string of array
projectIds
Optional

Matches will only include policies of this projectIds

string of array
phases
Optional

Matches will only include policies of this phases

boolean
expandPolicyDefinition
Optional
Constraints: default: false

Expand policy definition

integer
$top
Optional

Number of records you want

$top example
1
integer
$skip
Optional

Number of records you want to skip

$skip example
1
string
$orderby
Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Authentication/Authorization
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Returns PagePolicyAssignmentObjectNode of type(s) application/json 
"PagePolicyAssignmentObjectNode Object"
array of object
content
Optional

An assignment of a policy to a target resource.

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/policy/api/policyAssignments
On This Page
Policy Assignments Operations
GET
Get Assignments