Get Policies 1

Get Policies 1

Find all the policies associated with current org.

Request
URI
GET
https://{api_host}/policy/api/policies
COPY
Query Parameters
boolean
expandDefinition
Optional

Retrieves policy definition information for each returned policy.

boolean
expandOpaRegoCriteria
Optional

Retrieves OPA Rego criteria, if defined, for each returned policy.

boolean
computeStats
Optional

computeStats

string
search
Optional

Matches will start with this string in their name or have this string somewhere in their description.

string
typeId
Optional

typeId

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.

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
This operation uses the following authentication methods.
Responses
200

OK

Returns PagePolicy of type(s) application/json 
{
    "content": [
        {
            "createdAt": "string",
            "createdBy": "string",
            "creator": {
                "email": "string",
                "firstname": "string",
                "id": "string",
                "lastname": "string",
                "type": "string"
            },
            "criteria": {
                "matchExpression": [
                    {}
                ]
            },
            "definition": {},
            "definitionLegend": {
                "definitionLegend": {
                    "description": "string",
                    "error": "string",
                    "id": "string",
                    "name": "string",
                    "properties": {
                        "properties": {}
                    }
                }
            },
            "description": "string",
            "enforcementType": "string",
            "id": "string",
            "lastUpdatedAt": "string",
            "lastUpdatedBy": "string",
            "lastUpdater": {
                "email": "string",
                "firstname": "string",
                "id": "string",
                "lastname": "string",
                "type": "string"
            },
            "name": "string",
            "opaRegoCriteria": "string",
            "orgId": "string",
            "projectId": "string",
            "scopeCriteria": {
                "matchExpression": [
                    {}
                ]
            },
            "statistics": {
                "conflictCount": 0,
                "enforcedCount": 0,
                "notEnforcedCount": 0
            },
            "typeId": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ],
    "totalElements": 0,
    "totalPages": 0
}
array of object
content
Optional

The policy to be created or updated

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


401

Unauthorized

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

The policy to be created or updated

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


403

Forbidden

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

The policy to be created or updated

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/policies
On This Page
Policies Operations
GET
Get Policies 1
POST
Create Policy 1
DELETE
Delete Policy 1
GET
Get Policy 1