v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

List org group policies

List policies for an organization group. Requires a filter on org group ID.

get/api/v2/org_group_policies

Query parameters

filter[org_group_id]string uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef0123456789

Filter policies by org group ID.

filter[policy_name]string

Example:monitor_timezone

Filter policies by policy name.

page[number]integer

The page number to return.

page[size]integer

Example:50

The number of items per page. Maximum is 1000.

sort'id' | '-id' | 'name' | '-name'

Field to sort policies by.

Example:id

Field to sort policies by. Supported values: id, name, -id, -name. Defaults to id.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "content": {
          "value": "UTC"
        },
        "enforcement_tier": "OVERRIDE_ALLOWED",
        "modified_at": "2024-01-15T10:30:00Z",
        "policy_name": "monitor_timezone",
        "policy_type": "org_config"
      },
      "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_policies"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}