Palo Alto Networks User Groups API
The User Groups API from Palo Alto Networks — 2 operation(s) for user groups.
OpenAPI Specification
openapi: 3.2.0
info:
title: Prisma Browser Management Console Public User Groups API
version: 1.0.0
description: This Open API spec file was created on May 06, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html). All other marks mentioned herein may be trademarks of their respective companies.
security:
- BearerAuth: []
tags:
- name: User Groups
paths:
/seb-api/v1/user-groups:
get:
summary: Returns a list of user groups
description: Retrieve the user groups details through this Application Programming Interface endpoint.
operationId: GetSeb-apiV1User-groups
responses:
'200':
description: A list of user groups
content:
application/json:
schema:
type: object
properties:
pageInfo:
$ref: '#/components/schemas/PageInfo'
data:
type: array
items:
$ref: '#/components/schemas/UserGroup'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'500':
description: Internal server error
parameters:
- name: limit
in: query
description: Number of user requests to return
required: false
schema:
type: integer
format: int32
- name: cursor
in: query
description: An optional opaque string that defines from where to start listing
required: false
schema:
type: string
tags:
- User Groups
post:
summary: Creates a new user group
description: Create the user groups details through this Application Programming Interface endpoint.
operationId: PostSeb-apiV1User-groups
responses:
'201':
description: User group created successfully
content:
application/json:
schema:
type: object
properties:
userGroupId:
type: string
description: The ID of the newly created user group
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'500':
description: Internal server error
parameters: []
tags:
- User Groups
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the user group
userIds:
type: array
items:
type: string
description: List of user IDs
required:
- name
- userIds
/seb-api/v1/user-groups/{id}:
get:
summary: Returns a single user group by ID
description: Retrieve the {id} details through this Application Programming Interface endpoint.
operationId: GetSeb-apiV1User-groupsbyid
responses:
'200':
description: A single user group
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroup'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: User group not found
'500':
description: Internal server error
parameters:
- name: id
in: path
required: true
description: The ID of the user group to retrieve
schema:
type: string
tags:
- User Groups
put:
summary: Updates a user group
description: Update the {id} details through this Application Programming Interface endpoint.
operationId: PutSeb-apiV1User-groupsbyid
responses:
'200':
description: User group updated successfully
content:
application/json:
schema:
type: object
properties:
userGroupId:
type: string
description: The ID of the updated user group
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: User group not found
'500':
description: Internal server error
parameters:
- name: id
in: path
required: true
description: The ID of the user group to update
schema:
type: string
tags:
- User Groups
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
users:
type: array
items:
type: object
properties:
userId:
type: string
description: User ID
action:
type: string
enum:
- add
- remove
description: Action to perform (add or remove the user)
required:
- userId
- action
description: List of user updates
required:
- users
delete:
summary: Deletes a user group
description: Delete the {id} details through this Application Programming Interface endpoint.
operationId: DeleteSeb-apiV1User-groupsbyid
responses:
'200':
description: User group deleted successfully
content:
application/json:
schema:
type: object
properties:
userGroupId:
type: string
description: The ID of the deleted user group
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: User group not found
'500':
description: Internal server error
parameters:
- name: id
in: path
required: true
description: The ID of the user group to delete
schema:
type: string
tags:
- User Groups
components:
schemas:
ErrorResponse:
type: object
required:
- message
properties:
error:
type: string
message:
type: string
missingDeviceIds:
type: array
items:
type: string
description: List of device IDs that were not found (only present for device not found errors)
missingUserIds:
type: array
items:
type: string
description: List of user IDs that were not found (only present for user not found errors)
UserGroup:
type: object
properties:
id:
type: string
description: Unique identifier
name:
type: string
description: Name
lastUpdated:
type: string
format: date-time
description: Last updated
createdAt:
type: string
format: date-time
description: Created at
provider:
type: string
enum:
- sso
- local
description: Provider
required:
- id
- name
PageInfo:
type: object
properties:
hasNextPage:
type: boolean
description: When paginating forwards, are there more items?
cursor:
type:
- string
- 'null'
description: When paginating forwards, the cursor to continue.
required:
- hasNextPage
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Enter your JWT Bearer token to authorize.