NetBox users API
The users API from NetBox — 14 operation(s) for users.
OpenAPI Specification
openapi: 3.0.3
info:
title: NetBox REST authentication-check users API
version: 4.5.9 (4.5)
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).
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: 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: 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
- 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
- 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/GroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/GroupRequest'
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/GroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/GroupRequest'
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: path
name: id
schema:
type: integer
description: A unique integer value identifying this group.
required: true
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: 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: 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
- 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
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/OwnerGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/OwnerGroupRequest'
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/OwnerGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/OwnerGroupRequest'
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: path
name: id
schema:
type: integer
description: A unique integer value identifying this owner group.
required: true
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: 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: group
schema:
type: array
items:
type: string
description: Group (name)
explode: true
style: form
- in: query
name: group__n
schema:
type: array
items:
type: string
description: Group (name)
explode: true
style: form
- in: query
name: group_id
schema:
type: array
items:
type: integer
nullable: true
description: Group (ID)
explode: true
style: form
- in: query
name: group_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Group (ID)
explode: true
style: form
- 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
# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/openapi/netbox-users-api-openapi.yml