Get Group Contents (EA)

Retrieves details of a specific group based on its display name.

Note: This endpoint is currently in Early Availability.

Resource name: /api/v1/groups/{groupDisplayName}

Request Method: GET

Request parameters

Parameter Type Description
groupDisplayName string The display name of the group to retrieve details for.

Request example

Copy 
curl -X 'GET' \
  'https://<localhost>/afa/api/v1/groups/device' \
  -H 'accept: */*'

Status codes

Code Description
200 Group details retrieved successfully
400 Bad Request
401 Unauthorized
403 User does not have permission to view group details
404 Group not found
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response parameters

Param Type Description
entityType string Entity type
name string Unique identifier of the group (e.g., “group1”)
displayName string Name of the group (e.g., “Group1”)
firewalls array of objects List of firewall objects associated with the group
entityType string Type of the firewall entity (e.g., “FW_MGMT”)
name string Unique identifier of the firewall (e.g., “azureJsim”)
displayName string Name of the firewall (e.g., “AZURE_JSIM”)

Response example success 200

Copy 
{
  "entityType": "GROUP",
  "name": "group1",
  "displayName": "Group1",
  "firewalls": [
    {
      "entityType": "FW_MGMT",
      "name": "azureJsim",
      "displayName": "AZURE_JSIM"
    },
    {
      "entityType": "FW_VIRT",
      "name": "azureJsim_westeurope_VNet_Alfa_vm_co7_minimal_nsg",
      "displayName": "vm-co7-minimal-nsg"
    }
  ]
}

Response example failure 400

Copy 
{
    "error": "Invalid group display name",
    "description": "The group display name provided does not exist."
}