v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

List org group policy overrides

List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID.

get/api/v2/org_group_policy_overrides

Query parameters

filter[org_group_id]string uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef0123456789

Filter policy overrides by org group ID.

filter[policy_id]string uuid

Example:1a2b3c4d-5e6f-7890-abcd-ef0123456789

Filter policy overrides by policy ID.

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' | 'org_uuid' | '-org_uuid'

Field to sort overrides by.

Example:id

Field to sort overrides by. Supported values: id, org_uuid, -id, -org_uuid. Defaults to id.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "modified_at": "2024-01-15T10:30:00Z",
        "org_site": "us1",
        "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
      },
      "id": "9f8e7d6c-5b4a-3210-fedc-ba0987654321",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        },
        "org_group_policy": {
          "data": {
            "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
            "type": "org_group_policies"
          }
        }
      },
      "type": "org_group_policy_overrides"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}