External DocumentationTo learn more, visit the Opal Security documentation.
Parameters
| Parameter | Description |
|---|---|
| Cursor | A pagination token used to specify the next page of results. Can be obtained from the next property from a previous response. |
| Group IDs | A comma-separated list of group IDs to filter by. |
| Group Name | The name of the group to filter by. |
| Group Type | The group type to filter by. |
| Page Size | The maximum number of results to return per page. Maximum value is 1000. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Tag IDs | A comma-separated list of tag IDs to filter by. Only groups that have any of these tags applied will be returned. |
Example Output
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
"app_id": "b5a5ca27-0ea3-4d86-9199-2126d57d1fbd",
"description": "This group represents Active Directory group \"Payments Production Admin\". We use this AD group to facilitate staging deployments and qualifying new releases.",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"max_duration": 120,
"require_manager_approval": false,
"require_support_ticket": false
},
{
"group_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
"description": "Manages the Integrations Team on-call privileged resources. This group is automatically synced with the on-call rotation defined in PagerDuty.",
"admin_owner_id": "4220bc12-ab8a-4b5d-be7b-f6bbcf9159f3",
"max_duration": 360,
"require_manager_approval": false,
"require_support_ticket": true
}
]
}