Skip to main content
GET
/
relay
/
v1
/
policy-groups
/
{groupId}
Get a policy group by ID
curl --request GET \
  --url https://api.swarmd.ai/relay/v1/policy-groups/{groupId} \
  --header 'Authorization: Bearer <token>'
{
  "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": "<string>",
  "name": "<string>",
  "description": "<string>",
  "regoSource": "<string>",
  "regoSourceHash": "<string>",
  "bindings": [
    {
      "bindingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "<string>",
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupName": "<string>",
      "groupVersion": "<string>",
      "isLatestGroupVersion": true,
      "bindingLevel": "TENANT",
      "agent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "sourceAgent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "sinkAgent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "priority": 123,
      "validFrom": "2023-11-07T05:31:56Z",
      "validTo": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "currentOwnership": {
    "primaryUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "secondaryUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "effectiveFrom": "2023-11-07T05:31:56Z",
    "effectiveTo": "2023-11-07T05:31:56Z",
    "assignedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignmentReason": "<string>"
  },
  "bindingCount": 123,
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT token (USER, AGENT, or SERVICE auth)

Path Parameters

groupId
string<uuid>
required

Response

200 - application/json

OK

groupId
string<uuid>
version
string
name
string
description
string
regoSource
string
regoSourceHash
string
bindings
object[]
currentOwnership
object
bindingCount
integer<int64>
validFrom
string<date-time>
validTo
string<date-time>
createdAt
string<date-time>