Palo Alto Networks · JSON Structure

Cloud Identity Engine Api List_Specific_Groups Structure

Retrieve specific groups matching a name-based filter. Supports filtering of groups based on specific attributes and values (similar to the WHERE clause in SQL).

Type: object Properties: 2 Required: 1
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

list_specific_groups is a JSON Structure definition published by Palo Alto Networks, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name attrs

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/cloud-identity-engine-api-list_specific_groups-structure.json",
  "name": "list_specific_groups",
  "description": "Retrieve specific groups matching a name-based filter. Supports filtering of groups based on specific attributes and values (similar to the WHERE clause in SQL).",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "description": "Attribute-based filter.",
      "properties": {
        "attrName": {
          "type": "string",
          "description": "Attribute name",
          "enum": [
            "User Principal Name",
            "Common-Name",
            "Name",
            "Distinguished Name",
            "SAM Account Name",
            "Unique Identifier"
          ]
        },
        "attrValue": {
          "type": "string",
          "description": "Attribute value"
        },
        "match": {
          "type": "string",
          "description": "Value you want to match.",
          "enum": [
            "equal",
            "textSearch"
          ]
        }
      },
      "required": [
        "attrName",
        "attrValue",
        "match"
      ]
    },
    "attrs": {
      "type": "array",
      "description": "group attributes part of the response",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}