Palo Alto Networks Groups API

{'$ref': 'desc/groups/groups.md'}

Documentation GitHub OpenAPI

Business capability

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v34.03/groups List user groups (v34.03) · Get Groups #

Ask an LLM

“Which user groups are defined in Compute, per the v34.03 API?”

“Can I see group roles and permissions using version 34.03?”

Tell an agent

List all user groups with the v34.03 API.

Show groups and their roles via the older v34.03 endpoint.

POST /api/v34.03/groups Add a user group (v34.03) · Add a Group #

Ask an LLM

“Can I create a group mapped to an LDAP or SAML group on v34.03?”

“What fields does a new group take in the v34.03 API?”

Tell an agent

Add group {groupName} with role {role} using v34.03.

Create a v34.03 group {groupName} linked to the SAML group.

GET /api/v34.03/groups/names List group names (v34.03) · Get Group Names #

Ask an LLM

“Can I get just group names with the older v34.03 endpoint?”

“Which group names exist in version 34.03?”

Tell an agent

List only the group names, API v34.03.

Return group names from v34.03 without details.

DELETE /api/v34.03/groups/{id} Delete a user group (v34.03) · Delete a Group #

Ask an LLM

“Can I remove a group with the v34.03 API?”

“Is deleting a group by ID supported in version 34.03?”

Tell an agent destructive · confirm first

Delete group {id} via v34.03.

Remove the v34.03 user group {id}.

PUT /api/v34.03/groups/{id} Update a user group (v34.03) · Update a Group #

Ask an LLM

“Can I change a group's role through the v34.03 API?”

“How are group permissions edited on version 34.03?”

Tell an agent

Update v34.03 group {id} to role {role}.

Rename group {id} to {groupName} using API v34.03.

GET /api/v34.04/groups List user groups · Get Groups #

Ask an LLM

“Which user groups have access to Prisma Cloud Compute?”

“What role and permissions does each group carry?”

Tell an agent

List all user groups.

Show every group with its role and identity-provider mapping on v34.04.

POST /api/v34.04/groups Add a user group · Add a Group #

Ask an LLM

“How do I create a group that maps to an OIDC or LDAP group?”

“Can a new group be given a role when I create it?”

Tell an agent

Create group {groupName}.

Add a group {groupName} with role {role} on the current v34.04 API.

GET /api/v34.04/groups/names List group names · Get Group Names #

Ask an LLM

“Can I get a quick list of group names only?”

“What are the names of the groups I've defined?”

Tell an agent

List group names.

Give me the names of all groups, v34.04.

DELETE /api/v34.04/groups/{id} Delete a user group · Delete a Group #

Ask an LLM

“How do I delete a group that is no longer needed?”

“Can I remove a user group by its ID on v34.04?”

Tell an agent destructive · confirm first

Delete group {id}.

Remove user group {id} using the latest API version 34.04.

PUT /api/v34.04/groups/{id} Update a user group · Update a Group #

Ask an LLM

“How do I change the role or permissions of an existing group?”

“Can I switch which LDAP group an existing group maps to?”

Tell an agent

Update group {id} to have role {role}.

Change the name of group {id} to {groupName} on v34.04.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-groups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/palo-alto-networks:palo-alto-networks-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Palo Alto Networks Groups API
  x-description-source: desc/intro.md
  version: '1.0'
  description: 'Operations tagged Groups across 2 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Groups
  description: Groups. 5 operations in this definition.
  x-description-source: desc/groups/groups.md
paths:
  /api/v34.03/groups:
    get:
      description: 'Get Groups. GET /api/v34.03/groups on the Groups API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.Groups'
          description: Groups represents a list of groups
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: get-groups
      summary: Get Groups
      x-description-source: desc/groups/get.md
    post:
      description: 'Add a Group. POST /api/v34.03/groups on the Groups API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.Group'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: post-groups
      summary: Add a Group
      x-description-source: desc/groups/post.md
  /api/v34.03/groups/names:
    get:
      description: 'Get Group Names. GET /api/v34.03/groups/names on the Groups API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_string'
          description: ''
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: get-groups-names
      summary: Get Group Names
      x-description-source: desc/groups/names.md
  /api/v34.03/groups/{id}:
    delete:
      description: 'Delete a Group. DELETE /api/v34.03/groups/{id} on the Groups API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: delete-groups-id
      summary: Delete a Group
      x-description-source: desc/groups/id_delete.md
    put:
      description: 'Update a Group. PUT /api/v34.03/groups/{id} on the Groups API. Takes 1 path parameter, an optional request body. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.Group'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: put-groups-id
      summary: Update a Group
      x-description-source: desc/groups/id_put.md
  /api/v34.04/groups:
    get:
      description: 'Get Groups. GET /api/v34.04/groups on the Groups API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.Groups'
          description: Groups represents a list of groups
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: getApiV3404Groups
      summary: Get Groups
      x-description-source: desc/groups/get.md
      x-operation-id-source: normalized
      x-operation-id-original: get-groups
    post:
      description: 'Add a Group. POST /api/v34.04/groups on the Groups API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.Group'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: postApiV3404Groups
      summary: Add a Group
      x-description-source: desc/groups/post.md
      x-operation-id-source: normalized
      x-operation-id-original: post-groups
  /api/v34.04/groups/names:
    get:
      description: 'Get Group Names. GET /api/v34.04/groups/names on the Groups API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_string'
          description: ''
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: getApiV3404GroupsNames
      summary: Get Group Names
      x-description-source: desc/groups/names.md
      x-operation-id-source: normalized
      x-operation-id-original: get-groups-names
  /api/v34.04/groups/{id}:
    delete:
      description: 'Delete a Group. DELETE /api/v34.04/groups/{id} on the Groups API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: deleteApiV3404GroupsById
      summary: Delete a Group
      x-description-source: desc/groups/id_delete.md
      x-operation-id-source: normalized
      x-operation-id-original: delete-groups-id
    put:
      description: 'Update a Group. PUT /api/v34.04/groups/{id} on the Groups API. Takes 1 path parameter, an optional request body. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.Group'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Groups
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: putApiV3404GroupsById
      summary: Update a Group
      x-description-source: desc/groups/id_put.md
      x-operation-id-source: normalized
      x-operation-id-original: put-groups-id
components:
  schemas:
    api.Permissions:
      description: Permissions is a list of permissions
      items:
        $ref: '#/components/schemas/api.Permission'
      type: array
    string:
      type: string
    shared.User:
      description: User represents a local user in Twistlock
      properties:
        username:
          description: 'Name of a user.

            '
          type: string
      type: object
    -_string:
      items:
        $ref: '#/components/schemas/string'
      type: array
    types.Group:
      description: Group represents a console group
      properties:
        _id:
          description: 'Group name.

            '
          type: string
        groupId:
          description: 'Group identifier in the Azure SAML identification process.

            '
          type: string
        groupName:
          description: 'Group name.

            '
          type: string
        lastModified:
          description: 'Datetime when the group was created or last modified.

            '
          format: date-time
          type: string
        ldapGroup:
          description: 'Indicates if the group is an LDAP group (true) or not (false).

            '
          type: boolean
        oauthGroup:
          description: 'Indicates if the group is an OAuth group (true) or not (false).

            '
          type: boolean
        oidcGroup:
          description: 'Indicates if the group is an OpenID Connect group (true) or not (false).

            '
          type: boolean
        owner:
          description: 'User who created or modified the group.

            '
          type: string
        permissions:
          $ref: '#/components/schemas/api.Permissions'
        role:
          description: 'Role of the group.

            '
          type: string
        samlGroup:
          description: 'Indicates if the group is a SAML group (true) or not (false).

            '
          type: boolean
        user:
          description: 'Users in the group.

            '
          items:
            $ref: '#/components/schemas/shared.User'
          type: array
      type: object
    api.Permission:
      description: 'Permission represents a user or group''s permission to access a specific resource.

        Currently supported resources are:

        - Project - Access to a specific project (if empty, the Master Project by default)

        - Collection - The set of collections in the project that may be accessed (all if empty)

        If no permissions are assigned, all projects and collections may be accessed'
      properties:
        collections:
          description: 'List of collections the user can access.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        project:
          description: 'Names of projects which the user can access.

            '
          type: string
      type: object
    types.Groups:
      description: Groups represents a list of groups
      items:
        $ref: '#/components/schemas/types.Group'
      type: array
x-refined-from:
- palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json
- palo-alto-compute-openapi-34-04-145-sh-openapi.json