NetBox Labs users API

openapi: 3.0.3
info:
  title: NetBox REST authentication-check users API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: users
paths:
  /api/users/config/:
    get:
      operationId: users_config_retrieve
      description: An API endpoint via which a user can update his or her own UserConfig data (but no one else's).
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/users/groups/:
    get:
      operationId: users_groups_list
      description: Get a list of group objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__empty
        schema:
          type: boolean
      - in: query
        name: id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__empty
        schema:
          type: boolean
      - in: query
        name: name__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: notification_group_id
        schema:
          type: array
          items:
            type: integer
        description: Notification group (ID)
        explode: true
        style: form
      - in: query
        name: notification_group_id__n
        schema:
          type: array
          items:
            type: integer
        description: Notification group (ID)
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner__n
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner_id
        schema:
          type: array
          items:
            type: integer
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: owner_id__n
        schema:
          type: array
          items:
            type: integer
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: permission_id
        schema:
          type: array
          items:
            type: integer
        description: Permission (ID)
        explode: true
        style: form
      - in: query
        name: permission_id__n
        schema:
          type: array
          items:
            type: integer
        description: Permission (ID)
        explode: true
        style: form
      - in: query
        name: q
        schema:
          type: string
        description: Search
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      - in: query
        name: user_id
        schema:
          type: array
          items:
            type: integer
        description: User (ID)
        explode: true
        style: form
      - in: query
        name: user_id__n
        schema:
          type: array
          items:
            type: integer
        description: User (ID)
        explode: true
        style: form
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupList'
          description: ''
    post:
      operationId: users_groups_create
      description: Post a list of group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/GroupRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/GroupRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    put:
      operationId: users_groups_bulk_update
      description: Put a list of group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkGroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'
          description: ''
    patch:
      operationId: users_groups_bulk_partial_update
      description: Patch a list of group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkGroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'
          description: ''
    delete:
      operationId: users_groups_bulk_destroy
      description: Delete a list of group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/users/groups/{id}/:
    get:
      operationId: users_groups_retrieve
      description: Get a group object.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    put:
      operationId: users_groups_update
      description: Put a group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    patch:
      operationId: users_groups_partial_update
      description: Patch a group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedGroupRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    delete:
      operationId: users_groups_destroy
      description: Delete a group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/users/owner-groups/:
    get:
      operationId: users_owner_groups_list
      description: Get a list of owner group objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__empty
        schema:
          type: boolean
      - in: query
        name: id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__empty
        schema:
          type: boolean
      - in: query
        name: name__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: q
        schema:
          type: string
        description: Search
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOwnerGroupList'
          description: ''
    post:
      operationId: users_owner_groups_create
      description: Post a list of owner group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/OwnerGroupRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/OwnerGroupRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/OwnerGroupRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/OwnerGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OwnerGroup'
          description: ''
    put:
      operationId: users_owner_groups_bulk_update
      description: Put a list of owner group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkOwnerGroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkOwnerGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OwnerGroup'
          description: ''
    patch:
      operationId: users_owner_groups_bulk_partial_update
      description: Patch a list of owner group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkOwnerGroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkOwnerGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OwnerGroup'
          description: ''
    delete:
      operationId: users_owner_groups_bulk_destroy
      description: Delete a list of owner group objects.
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/OwnerGroupRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/OwnerGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/users/owner-groups/{id}/:
    get:
      operationId: users_owner_groups_retrieve
      description: Get a owner group object.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this owner group.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OwnerGroup'
          description: ''
    put:
      operationId: users_owner_groups_update
      description: Put a owner group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this owner group.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OwnerGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OwnerGroupRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OwnerGroup'
          description: ''
    patch:
      operationId: users_owner_groups_partial_update
      description: Patch a owner group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this owner group.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOwnerGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedOwnerGroupRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OwnerGroup'
          description: ''
    delete:
      operationId: users_owner_groups_destroy
      description: Delete a owner group object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this owner group.
        required: true
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/users/owners/:
    get:
      operationId: users_owners_list
      description: Get a list of owner objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          

# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-users-api-openapi.yml