Get a group

get

Authorizations

defguard_sessionstringRequired

Path parameters

idinteger · int64Required

ID of the group.

Responses

200

Group details.

application/json

idinteger · int64Required

is_adminbooleanRequired

membersstring[]Required

namestringRequired

vpn_locationsstring[]Required

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

404

Group not found.

application/json

500

Unable to get group.

application/json

get/api/v1/group/{id}

GET /api/v1/group/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "is_admin": false,
  "members": [
    "user"
  ],
  "name": "name",
  "vpn_locations": [
    "location"
  ]
}