Skip to main content
GET
/
tenant-auth
/
v1
/
groups
List groups within a tenant
curl --request GET \
  --url https://api.swarmd.ai/tenant-auth/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "content": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "permissions": [
        {}
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "isDefault": true,
      "isAdmin": true,
      "version": "<string>",
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "permissions": [
          {}
        ],
        "firstName": "<string>",
        "lastName": "<string>",
        "source": "<string>",
        "groupIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "reason": "<string>"
    }
  ],
  "totalElements": 123,
  "totalActive": 123,
  "totalArchived": 123,
  "totalPages": 123,
  "size": 123,
  "number": 123,
  "first": true,
  "last": true,
  "empty": true
}

Authorizations

Authorization
string
header
required

JWT token (USER, AGENT, or SERVICE auth)

Query Parameters

archived
boolean
pageable
object
required

Response

200 - */*

OK

content
object[]
totalElements
integer<int64>
totalActive
integer<int64>
totalArchived
integer<int64>
totalPages
integer<int32>
size
integer<int32>
number
integer<int32>
first
boolean
last
boolean
empty
boolean