Palo Alto Networks Groups API

openapi: 3.2.0
info:
  title: Palo Alto Networks Groups API
  version: '1.0'
  description: 'Operations tagged Groups across 4 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, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
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: get-groups
      summary: Get Groups
      x-description-source: desc/groups/get.md
    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: post-groups
      summary: Add a Group
      x-description-source: desc/groups/post.md
  /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: get-groups-names
      summary: Get Group Names
      x-description-source: desc/groups/names.md
  /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: delete-groups-id
      summary: Delete a Group
      x-description-source: desc/groups/id_delete.md
    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: put-groups-id
      summary: Update a Group
      x-description-source: desc/groups/id_put.md
components:
  schemas:
    types.Groups:
      description: Groups represents a list of groups
      items:
        $ref: '#/components/schemas/types.Group'
      type: array
    string:
      type: string
    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
    -_string:
      items:
        $ref: '#/components/schemas/string'
      type: array
    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
    shared.User:
      description: User represents a local user in Twistlock
      properties:
        username:
          description: 'Name of a user.

            '
          type: string
      type: object
    api.Permissions:
      description: Permissions is a list of permissions
      items:
        $ref: '#/components/schemas/api.Permission'
      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
- palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json
- palo-alto-cwpp-openapi-34-04-145-saas-openapi.json