Palo Alto Networks · JSON Structure

Cloud Identity Engine Api Check_User_In_Particular_Group Structure

Check if a specific group has a particular user in it, filtered using attribute-based filter (to filter the group) and group-based filter (to filter the user)

Type: object Properties: 2 Required: 2

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

name filter

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

JSON Structure

{
  "$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-check_user_in_particular_group-structure.json",
  "name": "check_user_in_particular_group",
  "description": "Check if a specific group has a particular user in it, filtered using attribute-based filter (to filter the group) and group-based filter (to filter the user)",
  "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"
      ]
    },
    "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": [
    "name",
    "filter"
  ]
}