Palo Alto Networks · JSON Structure

Cloud Identity Engine Api List_Users_In_Particular_Group Structure

Retrieve specific attributes for users belonging to a particular group, filtered using the group-based filter.

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

list_users_in_particular_group 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

filter 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_users_in_particular_group-structure.json",
  "name": "list_users_in_particular_group",
  "description": "Retrieve specific attributes for users belonging to a particular group, filtered using the group-based filter.",
  "type": "object",
  "properties": {
    "filter": {
      "type": "object",
      "description": "Group-based filter.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "group"
          ]
        },
        "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"
          ]
        },
        "level": {
          "type": "string",
          "enum": [
            "immediate",
            "recursive"
          ]
        }
      },
      "required": [
        "type",
        "name",
        "level"
      ]
    },
    "attrs": {
      "type": "array",
      "description": "user attributes part of the response",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "filter"
  ]
}