Palo Alto Networks Users API

openapi: 3.2.0
info:
  title: Palo Alto Networks Users API
  version: '1.0'
  description: 'Operations tagged Users across 5 of this provider''s published API definitions: palo-alto-access-browser-mgmt-prismaaccess-browser-management-latest-openapi.yaml, 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: Users
paths:
  /seb-api/v1/users:
    get:
      summary: Returns a list of users
      description: Retrieve the users details through this Application Programming Interface endpoint.
      operationId: GetSeb-apiV1Users
      responses:
        '200':
          description: A list of users with pagination info
          content:
            application/json:
              schema:
                type: object
                properties:
                  pageInfo:
                    $ref: '#/components/schemas/PageInfo'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '400':
          description: Bad request
        '500':
          description: Internal server error
      parameters:
      - name: limit
        in: query
        description: Number of users to return
        required: false
        schema:
          type: integer
          format: int32
      - name: includeDeleted
        in: query
        description: Include deleted users
        required: false
        schema:
          type: boolean
      - name: user.name
        in: query
        description: Filter by user name
        required: false
        schema:
          type: string
      - name: user.email
        in: query
        description: Filter by user email
        required: false
        schema:
          type: string
      - name: user.first_seen_gte
        in: query
        description: Filter by first seen time or after
        required: false
        schema:
          type: string
          format: date-time
      - name: user.last_seen_lte
        in: query
        description: Filter by last seen time or before
        required: false
        schema:
          type: string
          format: date-time
      - name: user.status
        in: query
        description: Filter by user status
        required: false
        schema:
          $ref: '#/components/schemas/UserStatus'
      - name: cursor
        in: query
        description: An optional opaque string that defines from where to start listing
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: The field to sort by
        required: false
        schema:
          type: string
          enum:
          - user.name
          - user.email
          - user.first_seen
          - user.last_seen
          - user.status
      - name: order
        in: query
        description: The sort order
        required: false
        schema:
          $ref: '#/components/schemas/Order'
      tags:
      - Users
      security:
      - BearerAuth: []
  /seb-api/v1/users/{id}:
    get:
      summary: Returns a user by ID
      description: Retrieve the {id} details through this Application Programming Interface endpoint.
      operationId: GetSeb-apiV1Usersbyid
      responses:
        '200':
          description: A user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: string
      tags:
      - Users
      security:
      - BearerAuth: []
  /seb-api/v1/users/suspend:
    post:
      summary: Suspend users
      description: Suspend one or more users by changing their status to suspended. Suspended users will lose access to the browser from all of their known or future devices, except from their Prisma Browser Extension and mobile devices.
      operationId: PostSeb-apiV1UsersSuspend
      responses:
        '200':
          description: Users suspended successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSuspendResponse'
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
        '404':
          description: One or more users not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
      parameters: []
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserStatusChangeRequest'
      security:
      - BearerAuth: []
  /seb-api/v1/users/resume:
    post:
      summary: Resume suspended users
      description: Resume one or more suspended users by changing their status to active. Resumed users will regain access to the browser from all of their known or future devices.
      operationId: PostSeb-apiV1UsersResume
      responses:
        '200':
          description: Users resumed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResumeResponse'
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
        '404':
          description: One or more users not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
      parameters: []
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserStatusChangeRequest'
      security:
      - BearerAuth: []
  /seb-api/v1/users/force-reauth:
    post:
      summary: Force re-authentication for users
      description: Force re-authentication on all active devices for one or more users. Upon execution, targeted users will be required to re-authenticate to the browser on all of their devices.
      operationId: PostSeb-apiV1UsersForce-reauth
      responses:
        '200':
          description: Force re-authentication initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserForceReauthResponse'
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
        '404':
          description: One or more users not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorResponse:
                    $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
      parameters: []
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserStatusChangeRequest'
      security:
      - BearerAuth: []
  /api/v34.03/users:
    get:
      description: 'Get Users. GET /api/v34.03/users on the Users API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.UserList'
          description: UserList represents a list of users
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: get-users
      summary: Get Users
      x-description-source: desc/users/get.md
    post:
      description: 'Add Users. POST /api/v34.03/users on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.User'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: post-users
      summary: Add Users
      x-description-source: desc/users/post.md
    put:
      description: 'Update Users. PUT /api/v34.03/users on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.User'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: put-users
      summary: Update Users
      x-description-source: desc/users/put.md
  /api/v34.03/users/password:
    put:
      description: 'Update User Password. PUT /api/v34.03/users/password on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.UserPassword'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: user
      operationId: put-users-password
      summary: Update User Password
      x-description-source: desc/users/password_put.md
  /api/v34.03/users/{id}:
    delete:
      description: 'Delete Users. DELETE /api/v34.03/users/{id} on the Users 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:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: delete-users-id
      summary: Delete Users
      x-description-source: desc/users/id_delete.md
  /api/v34.04/users:
    get:
      description: 'Get Users. GET /api/v34.04/users on the Users API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.UserList'
          description: UserList represents a list of users
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: get-users
      summary: Get Users
      x-description-source: desc/users/get.md
    post:
      description: 'Add Users. POST /api/v34.04/users on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.User'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: post-users
      summary: Add Users
      x-description-source: desc/users/post.md
    put:
      description: 'Update Users. PUT /api/v34.04/users on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.User'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: put-users
      summary: Update Users
      x-description-source: desc/users/put.md
  /api/v34.04/users/password:
    put:
      description: 'Update User Password. PUT /api/v34.04/users/password on the Users API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.UserPassword'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Users
      x-prisma-cloud-target-env:
        permission: user
      operationId: put-users-password
      summary: Update User Password
      x-description-source: desc/users/password_put.md
  /api/v34.04/users/{id}:
    delete:
      description: 'Delete Users. DELETE /api/v34.04/users/{id} on the Users 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:
      - Users
      x-prisma-cloud-target-env:
        permission: userManagement
      operationId: delete-users-id
      summary: Delete Users
      x-description-source: desc/users/id_delete.md
components:
  schemas:
    UserStatusChangeRequest:
      type: object
      properties:
        userIds:
          type: array
          items:
            type: string
          description: List of user IDs
          minItems: 1
      required:
      - userIds
    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
    UserResumeResponse:
      type: object
      properties:
        message:
          type: string
          example: Users resumed successfully
    Order:
      type: string
      description: The sort order
      enum:
      - asc
      - desc
    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)
    UserStatus:
      type: string
      description: User status
      enum:
      - active
      - suspended
    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
    UserSuspendResponse:
      type: object
      properties:
        message:
          type: string
          example: Users suspended successfully
    UserForceReauthResponse:
      type: object
      properties:
        message:
          type: string
          example: Force re-authentication initiated for 2 users
    User:
      type: object
      properties:
        id:
          type: string
          format: string
          description: Unique identifier
        externalId:
          type: string
          format: string
          description: External identifier
        email:
          type: string
          description: Email
        lastSeen:
          type: string
          format: date-time
          description: Last seen time
        firstSeen:
          type: string
          format: date-time
          description: First seen time
        name:
          type: string
          description: Name
        profilePictureURL:
          type: string
          description: Profile Picture URL
        deletedTime:
          type: string
          format: date-time
          description: Deleted Time
        status:
          $ref: '#/components/schemas/UserStatus'
        provider:
          type: string
          description: Provider
          enum:
          - saml
          - local
          - oidc
        deviceIds:
          type: array
          description: Device IDs
          items:
            type: string
        userGroups:
          type: array
          description: User Groups
          items:
            $ref: '#/components/schemas/UserGroup'
      required:
      - id
      - email
      - lastSeen
      - firstSeen
      - name
      - profilePictureURL
      - deletedTime
      - status
      - provider
      - externalId
    api.UserList:
      description: UserList represents a list of users
      items:
        $ref: '#/components/schemas/api.User'
      type: array
    api.AuthType:
      description: AuthType is the user authentication type
      enum:
      - - saml
        - ldap
        - basic
        - oauth
        - oidc
      type: string
    string:
      type: string
    types.UserPassword:
      description: UserPassword represents a new user password
      properties:
        newPassword:
          description: 'New password to assign to the user who is invoking the API.

            '
          type: string
        oldPassword:
          description: 'User''s existing password to replace.

            '
          type: string
      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
    api.Permissions:
      description: Permissions is a list of permissions
      items:
        $ref: '#/components/schemas/api.Permission'
      type: array
    api.User:
      description: User represents a user in Twistlock
      properties:
        authType:
          $ref: '#/components/schemas/api.AuthType'
        description:
          description: 'Description for user.

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

            '
          format: date-time
          type: string
        password:
          description: 'Password for authentication.

            '
          type: string
        permissions:
          $ref: '#/components/schemas/api.Permissions'
        role:
          description: 'User role.

            '
          type: string
        username:
          description: 'Username for authentication.

            '
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your JWT Bearer token to authorize.
x-refined-from:
- palo-alto-access-browser-mgmt-prismaaccess-browser-management-latest-openapi.yaml
- 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