Palo Alto Networks · JSON Structure

Cloud Identity Engine Api List_Groups_User_Belongs_To Structure

Retrieve all groups containing specific users based on user-filter.

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

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

Properties

filter

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_groups_user_belongs_to-structure.json",
  "name": "list_groups_user_belongs_to",
  "description": "Retrieve all groups containing specific users based on user-filter.",
  "type": "object",
  "properties": {
    "filter": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        "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": [
        "type",
        "name"
      ]
    }
  },
  "required": [
    "filter"
  ]
}