List security policies

Lists policies for the team or organization in creation order. Pagination count is the number of policies on this page. Authentication values are redacted.

Required permission

Account > Networking > SecurityPolicies > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
min
1
max
100
page
integer
The page number to access.
min
1
cursor
string
The cursor returned from the previous page of results, used to request the next page.
min length
24
max length
24

Response body

{object}
Response object.

data
{object} required
Result data.

securityPolicies
[array] required

{object}

id
string required
pattern
^[A-Za-z0-9-]+$
uid
string required
Permanent identifier for the resource. Unlike `id`, it never changes and is never reused.
min length
24
max length
24
name
string required
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
entityType
string required
one of
team, org
spec
(multiple options: anyOf) required
lifecycleStatus
string required
one of
created, pending, error, deleting, deletion_error
createdAt
string required
updatedAt
string required
state
{object}

lastSyncAttemptAt
string
lastSyncedAt
string
counts
{object}

matched
integer required
excluded
integer required
unsupported
integer required
pending
integer required
inSync
integer required
error
integer required

warnings
[array]

{object}

code
string required
one of
defaultOverrodeEnforced
winningDefaultPolicyId
string required
shadowedEnforcedPolicyIds
[array] required

string

affectedCount
integer required
risk
string required
one of
nestedDelegation, broadeningDelegation

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

GET /v1/security-policies

GET /v1/teams/{teamId}/security-policies

Example response

200 OK

A page of security policies.

JSON

{
  "data": {
    "securityPolicies": [
      {
        "uid": "68f0aa1b9c4e2d7f11a3b402"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}