list_specific_groups

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-list-specific-groups-schema.json",
  "title": "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).",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-directory-sync-service-api-openapi.yml#/components/schemas/list_specific_groups",
  "allOf": [
    {
      "$ref": "#/$defs/list_all_groups_in_domain"
    }
  ],
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "$ref": "#/$defs/attr_based_filter"
    },
    "attrs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "group attributes part of the response"
    }
  },
  "$defs": {
    "attr_based_filter": {
      "type": "object",
      "description": "Attribute-based filter.",
      "required": [
        "attrName",
        "attrValue",
        "match"
      ],
      "properties": {
        "attrName": {
          "description": "Attribute name",
          "type": "string",
          "enum": [
            "User Principal Name",
            "Common-Name",
            "Name",
            "Distinguished Name",
            "SAM Account Name",
            "Unique Identifier"
          ]
        },
        "attrValue": {
          "description": "Attribute value",
          "type": "string"
        },
        "match": {
          "description": "Value you want to match.",
          "type": "string",
          "enum": [
            "equal",
            "textSearch"
          ]
        }
      }
    },
    "domain_param": {
      "type": "object",
      "description": "Domain name for a specific directory.",
      "required": [
        "domain"
      ],
      "properties": {
        "domain": {
          "type": "string",
          "description": "Domain name of the target directory."
        }
      }
    },
    "list_all_groups_in_domain": {
      "description": "Retrieve all groups in a particular domain.",
      "allOf": [
        {
          "$ref": "#/$defs/domain_param"
        },
        {
          "$ref": "#/$defs/pagination_params"
        }
      ],
      "required": [
        "attrs"
      ],
      "properties": {
        "attrs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Group attributes included as part of the response."
        },
        "useNormalizedAttrs": {
          "type": "string",
          "enum": [
            "True",
            "False"
          ]
        }
      }
    },
    "pagination_params": {
      "type": "object",
      "description": "Optional pagination parameters.",
      "properties": {
        "pageNum": {
          "type": "integer",
          "description": "Page number to retrieve (starting from page 1)."
        },
        "pageSz": {
          "type": "integer",
          "description": "Number of records per page (max is 1000 per page)."
        }
      }
    }
  }
}