list_users_in_particular_group

{
  "$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-users-in-particular-group-schema.json",
  "title": "list_users_in_particular_group",
  "description": "Retrieve specific attributes for users belonging to a particular group, filtered using the group-based filter.",
  "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_users_in_particular_group",
  "allOf": [
    {
      "$ref": "#/$defs/domain_param"
    },
    {
      "$ref": "#/$defs/pagination_params"
    }
  ],
  "required": [
    "filter"
  ],
  "properties": {
    "filter": {
      "$ref": "#/$defs/group_filter"
    },
    "attrs": {
      "type": "array",
      "description": "user attributes part of the response",
      "items": {
        "type": "string"
      }
    }
  },
  "$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."
        }
      }
    },
    "group_filter": {
      "type": "object",
      "description": "Group-based filter.",
      "required": [
        "type",
        "name",
        "level"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "group"
          ]
        },
        "name": {
          "$ref": "#/$defs/attr_based_filter"
        },
        "level": {
          "type": "string",
          "enum": [
            "immediate",
            "recursive"
          ]
        }
      }
    },
    "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)."
        }
      }
    }
  }
}