NetBox users API
The users API from NetBox — 14 operation(s) for users.
NetBox users API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 56 operations across 14 paths, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).
Requests are made against the base URL https://demo.netbox.dev/api.
56 operations
14 paths
32 schemas
12 DELETE13 GET12 PATCH7 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox users API declares
2 security schemes
for authenticating requests.
An API key is passed in the cookie as sessionid (cookieAuth).
An API key is passed in the header as Authorization (tokenAuth).
tokenAuth— Token (v1) or Bearer . (v2)
Paths & Operations 56
Across 14 paths, the API surfaces 56 operations — 12 DELETE, 13 GET, 12 PATCH, 7 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
users 56
GET
/api/users/config/
An API endpoint via which a user can update his or her own UserConfig data (but no one else's).
GET
/api/users/groups/
Get a list of group objects.
POST
/api/users/groups/
Post a list of group objects.
PUT
/api/users/groups/
Put a list of group objects.
PATCH
/api/users/groups/
Patch a list of group objects.
DELETE
/api/users/groups/
Delete a list of group objects.
GET
/api/users/groups/{id}/
Get a group object.
PUT
/api/users/groups/{id}/
Put a group object.
PATCH
/api/users/groups/{id}/
Patch a group object.
DELETE
/api/users/groups/{id}/
Delete a group object.
GET
/api/users/owner-groups/
Get a list of owner group objects.
POST
/api/users/owner-groups/
Post a list of owner group objects.
PUT
/api/users/owner-groups/
Put a list of owner group objects.
PATCH
/api/users/owner-groups/
Patch a list of owner group objects.
DELETE
/api/users/owner-groups/
Delete a list of owner group objects.
GET
/api/users/owner-groups/{id}/
Get a owner group object.
PUT
/api/users/owner-groups/{id}/
Put a owner group object.
PATCH
/api/users/owner-groups/{id}/
Patch a owner group object.
DELETE
/api/users/owner-groups/{id}/
Delete a owner group object.
GET
/api/users/owners/
Get a list of owner objects.
POST
/api/users/owners/
Post a list of owner objects.
PUT
/api/users/owners/
Put a list of owner objects.
PATCH
/api/users/owners/
Patch a list of owner objects.
DELETE
/api/users/owners/
Delete a list of owner objects.
GET
/api/users/owners/{id}/
Get a owner object.
PUT
/api/users/owners/{id}/
Put a owner object.
PATCH
/api/users/owners/{id}/
Patch a owner object.
DELETE
/api/users/owners/{id}/
Delete a owner object.
GET
/api/users/permissions/
Get a list of permission objects.
POST
/api/users/permissions/
Post a list of permission objects.
PUT
/api/users/permissions/
Put a list of permission objects.
PATCH
/api/users/permissions/
Patch a list of permission objects.
DELETE
/api/users/permissions/
Delete a list of permission objects.
GET
/api/users/permissions/{id}/
Get a permission object.
PUT
/api/users/permissions/{id}/
Put a permission object.
PATCH
/api/users/permissions/{id}/
Patch a permission object.
DELETE
/api/users/permissions/{id}/
Delete a permission object.
GET
/api/users/tokens/
Get a list of token objects.
POST
/api/users/tokens/
Post a list of token objects.
PUT
/api/users/tokens/
Put a list of token objects.
PATCH
/api/users/tokens/
Patch a list of token objects.
DELETE
/api/users/tokens/
Delete a list of token objects.
GET
/api/users/tokens/{id}/
Get a token object.
PUT
/api/users/tokens/{id}/
Put a token object.
PATCH
/api/users/tokens/{id}/
Patch a token object.
DELETE
/api/users/tokens/{id}/
Delete a token object.
POST
/api/users/tokens/provision/
Non-authenticated REST API endpoint via which a user may create a Token.
GET
/api/users/users/
Get a list of user objects.
POST
/api/users/users/
Post a list of user objects.
PUT
/api/users/users/
Put a list of user objects.
PATCH
/api/users/users/
Patch a list of user objects.
DELETE
/api/users/users/
Delete a list of user objects.
GET
/api/users/users/{id}/
Get a user object.
PUT
/api/users/users/{id}/
Put a user object.
PATCH
/api/users/users/{id}/
Patch a user object.
DELETE
/api/users/users/{id}/
Delete a user object.
Schemas 32
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Token (15 properties), TokenProvision (14 properties), User (13 properties), ObjectPermission (12 properties). Each schema is shown below with its type and property counts.
PaginatedObjectPermissionList
object
4 properties
2 required
Token
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
15 properties
7 required
OwnerGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties
1 required
BriefOwnerGroup
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties
4 required
PatchedOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties
BriefUserRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
1 property
1 required
PaginatedOwnerGroupList
object
4 properties
2 required
PatchedGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties
PaginatedTokenList
object
4 properties
2 required
PaginatedOwnerList
object
4 properties
2 required
NestedGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties
5 required
UserRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties
2 required
TokenProvision
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
14 properties
8 required
ObjectPermissionRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties
3 required
PatchedObjectPermissionRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties
PatchedOwnerGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties
BriefUser
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties
4 required
PaginatedUserList
object
4 properties
2 required
ObjectPermission
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
12 properties
7 required
PatchedUserRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties
PaginatedGroupList
object
4 properties
2 required
GroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties
1 required
Group
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties
6 required
OwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties
2 required
OwnerGroup
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
7 properties
6 required
User
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
13 properties
5 required
TokenProvisionRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties
2 required
TokenRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
1 required
NestedUser
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties
5 required
BriefOwnerGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties
1 required
PatchedTokenRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
Owner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.
NetBox GraphQL API
NetBox authentication-check API
NetBox circuits API
NetBox core API
NetBox dcim API
NetBox extras API
NetBox ipam API
NetBox schema API
NetBox status API
NetBox tenancy API
NetBox virtualization API
NetBox vpn API
#users