The User Management section of the InvenTree API schema is documented below.
InvenTree API 435¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
user¶
GET /api/user/¶
Description
List endpoint for detail on all users.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
is_active |
query | boolean | No | ||
is_staff |
query | boolean | No | ||
is_superuser |
query | boolean | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. Searched fields: first_name, last_name, username. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/UserCreate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/user/¶
Description
List endpoint for detail on all users.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new User.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new User.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new User.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
Response 201 Created
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "Serializer for creating a new User.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
GET /api/user/group/¶
Description
List endpoint for all auth groups.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
permission_detail |
query | boolean | False | No | Include permission details |
role_detail |
query | boolean | True | No | Include role details |
search |
query | string | No | A search term. Searched fields: name. | |
user_detail |
query | boolean | False | No | Include user details |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Group"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/user/group/¶
Description
List endpoint for all auth groups.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
Response 201 Created
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
DELETE /api/user/group/{id}/¶
Description
Detail endpoint for a particular auth group.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/user/group/{id}/¶
Description
Detail endpoint for a particular auth group.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No | ||
permission_detail |
query | boolean | False | No | Include permission details |
role_detail |
query | boolean | True | No | Include role details |
user_detail |
query | boolean | False | No | Include user details |
Response 200 OK
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
PATCH /api/user/group/{id}/¶
Description
Detail endpoint for a particular auth group.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
Response 200 OK
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
PUT /api/user/group/{id}/¶
Description
Detail endpoint for a particular auth group.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the request body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
Response 200 OK
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for a 'Group'.",
"properties": {
"name": {
"maxLength": 150,
"type": "string"
},
"permissions": {
"additionalProperties": {},
"description": "Return a list of permissions associated with the group.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true,
"readOnly": true,
"type": "array"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
DELETE /api/user/me/¶
Description
Detail endpoint for current user.
Permissions: - User can edit their own details via this endpoint - Only a subset of fields are available here
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/user/me/¶
Description
Detail endpoint for current user.
Permissions: - User can edit their own details via this endpoint - Only a subset of fields are available here
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
PATCH /api/user/me/¶
Description
Detail endpoint for current user.
Permissions: - User can edit their own details via this endpoint - Only a subset of fields are available here
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
PUT /api/user/me/¶
Description
Detail endpoint for current user.
Permissions: - User can edit their own details via this endpoint - Only a subset of fields are available here
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "API serializer specifically for the 'me' endpoint.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/UserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
GET /api/user/owner/¶
Description
List API endpoint for Owner model.
Cannot create a new Owner object via the API, but can view existing instances.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
is_active |
query | boolean | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"label": "string",
"name": "string",
"owner_id": 170,
"owner_model": "string",
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Owner"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/user/owner/{id}/¶
Description
Detail API endpoint for Owner model.
Cannot edit or delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"label": "string",
"name": "string",
"owner_id": 74,
"owner_model": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for an \"Owner\" (either a \"user\" or a \"group\").",
"properties": {
"label": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"owner_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"owner_model": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"label",
"name",
"owner_model",
"pk"
],
"type": "object"
}
GET /api/user/profile/¶
Description
Detail endpoint for the user profile.
Permissions: - Any authenticated user has write access against this endpoint - The endpoint always returns the profile associated with the current user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the response body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
PATCH /api/user/profile/¶
Description
Detail endpoint for the user profile.
Permissions: - Any authenticated user has write access against this endpoint - The endpoint always returns the profile associated with the current user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
Response 200 OK
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the response body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
PUT /api/user/profile/¶
Description
Detail endpoint for the user profile.
Permissions: - Any authenticated user has write access against this endpoint - The endpoint always returns the profile associated with the current user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the request body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
Response 200 OK
{
"active": true,
"contact": "string",
"displayname": "string",
"language": "string",
"location": "string",
"organisation": "string",
"position": "string",
"primary_group": 0,
"status": "string",
"theme": null,
"type": null,
"widgets": null
}
Schema of the response body
{
"description": "Serializer for the UserProfile model.",
"properties": {
"active": {
"description": "User is actively using the system",
"type": "boolean"
},
"contact": {
"description": "Preferred contact information for the user",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"displayname": {
"description": "Chosen display name for the user",
"maxLength": 255,
"nullable": true,
"title": "Display Name",
"type": "string"
},
"language": {
"description": "Preferred language for the user",
"maxLength": 10,
"nullable": true,
"type": "string"
},
"location": {
"description": "User location information",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"organisation": {
"description": "Users primary organisation/affiliation",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"position": {
"description": "Main job title or position",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"primary_group": {
"description": "Primary group for the user",
"nullable": true,
"type": "integer"
},
"status": {
"description": "User status message",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"theme": {
"description": "Settings for the web UI as JSON - do not edit manually!",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/UserTypeEnum"
}
],
"description": "Which type of user is this?\n\n* `bot` - Bot\n* `internal` - Internal\n* `external` - External\n* `guest` - Guest",
"title": "User Type"
},
"widgets": {
"description": "Settings for the dashboard widgets as JSON - do not edit manually!",
"nullable": true
}
},
"type": "object"
}
GET /api/user/roles/¶
Description
API endpoint which lists the available role permissions for the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"is_staff": true,
"is_superuser": true,
"permissions": {},
"roles": {},
"user": 0,
"username": "string"
}
Schema of the response body
{
"description": "Serializer for a roles associated with a given user.",
"properties": {
"is_staff": {
"description": "Designates whether the user can log into this admin site.",
"title": "Staff status",
"type": "boolean"
},
"is_superuser": {
"description": "Designates that this user has all permissions without explicitly assigning them.",
"title": "Superuser status",
"type": "boolean"
},
"permissions": {
"additionalProperties": {},
"description": "Permissions associated with the user.",
"nullable": true,
"readOnly": true,
"type": "object"
},
"roles": {
"additionalProperties": {},
"description": "Roles associated with the user.",
"readOnly": true,
"type": "object"
},
"user": {
"type": "integer"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"pattern": "^[\\w.@+-]+$",
"type": "string"
}
},
"required": [
"roles",
"user",
"username"
],
"type": "object"
}
GET /api/user/ruleset/¶
Description
List endpoint for all RuleSet instances.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
group |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
name |
query | string | No | Permission set * `admin` - Admin * `part_category` - Part Categories * `part` - Parts * `stock_location` - Stock Locations * `stock` - Stock Items * `build` - Build Orders * `purchase_order` - Purchase Orders * `sales_order` - Sales Orders * `return_order` - Return Orders | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. Searched fields: name. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RuleSet"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/user/ruleset/{id}/¶
Description
Detail endpoint for a particular RuleSet instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/user/ruleset/{id}/¶
Description
Detail endpoint for a particular RuleSet instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
PATCH /api/user/ruleset/{id}/¶
Description
Detail endpoint for a particular RuleSet instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
PUT /api/user/ruleset/{id}/¶
Description
Detail endpoint for a particular RuleSet instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
Response 200 OK
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a RuleSet.",
"properties": {
"can_add": {
"description": "Permission to add items",
"title": "Add",
"type": "boolean"
},
"can_change": {
"description": "Permissions to edit items",
"title": "Change",
"type": "boolean"
},
"can_delete": {
"description": "Permission to delete items",
"title": "Delete",
"type": "boolean"
},
"can_view": {
"description": "Permission to view items",
"title": "View",
"type": "boolean"
},
"group": {
"description": "Group",
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Return the translated label for this ruleset.",
"readOnly": true,
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/NameEnum"
}
],
"description": "Permission set\n\n* `admin` - Admin\n* `part_category` - Part Categories\n* `part` - Parts\n* `stock_location` - Stock Locations\n* `stock` - Stock Items\n* `build` - Build Orders\n* `purchase_order` - Purchase Orders\n* `sales_order` - Sales Orders\n* `return_order` - Return Orders",
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"group",
"label",
"name",
"pk"
],
"type": "object"
}
GET /api/user/token/¶
Description
Return an API token if the user is authenticated.
- If the user already has a matching token, delete it and create a new one
- Existing tokens are never exposed again via the API
- Once the token is provided, it can be used for auth until it expires
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
name |
query | string | No | Name of the token |
Response 200 OK
{
"expiry": "2022-04-13",
"name": "string",
"token": "string"
}
Schema of the response body
{
"description": "Serializer for the GetAuthToken API endpoint.",
"properties": {
"expiry": {
"format": "date",
"readOnly": true,
"type": "string"
},
"name": {
"type": "string"
},
"token": {
"readOnly": true,
"type": "string"
}
},
"required": [
"expiry",
"name",
"token"
],
"type": "object"
}
GET /api/user/tokens/¶
Description
List of user tokens for current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
revoked |
query | boolean | No | ||
search |
query | string | No | A search term. Searched fields: key, name. | |
user |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ApiToken"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/user/tokens/¶
Description
List of user tokens for current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the ApiToken model.",
"properties": {
"active": {
"description": "Test if this token is active.",
"readOnly": true,
"type": "boolean"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiry": {
"description": "Token expiry date",
"format": "date",
"title": "Expiry Date",
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"in_use": {
"description": "Return True if the token is currently used to call the endpoint.",
"readOnly": true,
"type": "boolean"
},
"last_seen": {
"description": "Last time the token was used",
"format": "date",
"nullable": true,
"type": "string"
},
"name": {
"description": "Custom token name",
"maxLength": 100,
"title": "Token Name",
"type": "string"
},
"revoked": {
"description": "Token has been revoked",
"type": "boolean"
},
"token": {
"description": "Provide a redacted version of the token.\n\nThe *raw* key value should never be displayed anywhere!",
"readOnly": true,
"type": "string"
},
"user": {
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"active",
"created",
"id",
"in_use",
"token",
"user_detail"
],
"type": "object"
}
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the ApiToken model.",
"properties": {
"active": {
"description": "Test if this token is active.",
"readOnly": true,
"type": "boolean"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiry": {
"description": "Token expiry date",
"format": "date",
"title": "Expiry Date",
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"in_use": {
"description": "Return True if the token is currently used to call the endpoint.",
"readOnly": true,
"type": "boolean"
},
"last_seen": {
"description": "Last time the token was used",
"format": "date",
"nullable": true,
"type": "string"
},
"name": {
"description": "Custom token name",
"maxLength": 100,
"title": "Token Name",
"type": "string"
},
"revoked": {
"description": "Token has been revoked",
"type": "boolean"
},
"token": {
"description": "Provide a redacted version of the token.\n\nThe *raw* key value should never be displayed anywhere!",
"readOnly": true,
"type": "string"
},
"user": {
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"active",
"created",
"id",
"in_use",
"token",
"user_detail"
],
"type": "object"
}
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the ApiToken model.",
"properties": {
"active": {
"description": "Test if this token is active.",
"readOnly": true,
"type": "boolean"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiry": {
"description": "Token expiry date",
"format": "date",
"title": "Expiry Date",
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"in_use": {
"description": "Return True if the token is currently used to call the endpoint.",
"readOnly": true,
"type": "boolean"
},
"last_seen": {
"description": "Last time the token was used",
"format": "date",
"nullable": true,
"type": "string"
},
"name": {
"description": "Custom token name",
"maxLength": 100,
"title": "Token Name",
"type": "string"
},
"revoked": {
"description": "Token has been revoked",
"type": "boolean"
},
"token": {
"description": "Provide a redacted version of the token.\n\nThe *raw* key value should never be displayed anywhere!",
"readOnly": true,
"type": "string"
},
"user": {
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"active",
"created",
"id",
"in_use",
"token",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the ApiToken model.",
"properties": {
"active": {
"description": "Test if this token is active.",
"readOnly": true,
"type": "boolean"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiry": {
"description": "Token expiry date",
"format": "date",
"title": "Expiry Date",
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"in_use": {
"description": "Return True if the token is currently used to call the endpoint.",
"readOnly": true,
"type": "boolean"
},
"last_seen": {
"description": "Last time the token was used",
"format": "date",
"nullable": true,
"type": "string"
},
"name": {
"description": "Custom token name",
"maxLength": 100,
"title": "Token Name",
"type": "string"
},
"revoked": {
"description": "Token has been revoked",
"type": "boolean"
},
"token": {
"description": "Provide a redacted version of the token.\n\nThe *raw* key value should never be displayed anywhere!",
"readOnly": true,
"type": "string"
},
"user": {
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"active",
"created",
"id",
"in_use",
"token",
"user_detail"
],
"type": "object"
}
DELETE /api/user/tokens/{id}/¶
Description
Details for a user token.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/user/tokens/{id}/¶
Description
Details for a user token.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
all_users |
query | boolean | No | Display tokens for all users (superuser only) | |
id |
path | integer | No |
Response 200 OK
{
"active": true,
"created": "2022-04-13T15:42:05.901Z",
"expiry": "2022-04-13",
"id": 0,
"in_use": true,
"last_seen": "2022-04-13",
"name": "string",
"revoked": true,
"token": "string",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the ApiToken model.",
"properties": {
"active": {
"description": "Test if this token is active.",
"readOnly": true,
"type": "boolean"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiry": {
"description": "Token expiry date",
"format": "date",
"title": "Expiry Date",
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"in_use": {
"description": "Return True if the token is currently used to call the endpoint.",
"readOnly": true,
"type": "boolean"
},
"last_seen": {
"description": "Last time the token was used",
"format": "date",
"nullable": true,
"type": "string"
},
"name": {
"description": "Custom token name",
"maxLength": 100,
"title": "Token Name",
"type": "string"
},
"revoked": {
"description": "Token has been revoked",
"type": "boolean"
},
"token": {
"description": "Provide a redacted version of the token.\n\nThe *raw* key value should never be displayed anywhere!",
"readOnly": true,
"type": "string"
},
"user": {
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"active",
"created",
"id",
"in_use",
"token",
"user_detail"
],
"type": "object"
}
DELETE /api/user/{id}/¶
Description
Detail endpoint for a single user.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/user/{id}/¶
Description
Detail endpoint for a single user.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
PATCH /api/user/{id}/¶
Description
Detail endpoint for a single user.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
PUT /api/user/{id}/¶
Description
Detail endpoint for a single user.
Permissions: - Staff users (who also have the 'admin' role) can perform write operations - Otherwise authenticated users have read-only access
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the request body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
Response 200 OK
{
"email": "derp@meme.org",
"first_name": "string",
"group_ids": [
0
],
"groups": [
{
"name": "string",
"permissions": {},
"pk": 0,
"roles": [
{
"can_add": true,
"can_change": true,
"can_delete": true,
"can_view": true,
"group": 0,
"label": "string",
"name": null,
"pk": 0
}
],
"users": [
{
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string",
"pk": 0,
"username": "string"
}
]
}
],
"is_active": true,
"is_staff": true,
"is_superuser": true,
"last_name": "string",
"pk": 0,
"profile": null,
"username": "string"
}
Schema of the response body
{
"description": "Serializer for a User with a bit more info.",
"properties": {
"email": {
"description": "Email address of the user",
"format": "email",
"type": "string"
},
"first_name": {
"description": "First name of the user",
"type": "string"
},
"group_ids": {
"items": {
"type": "integer",
"writeOnly": true
},
"type": "array",
"writeOnly": true
},
"groups": {
"items": {
"$ref": "#/components/schemas/Group"
},
"readOnly": true,
"type": "array"
},
"is_active": {
"description": "Is this user account active",
"title": "Active",
"type": "boolean"
},
"is_staff": {
"description": "Does this user have staff permissions",
"title": "Staff",
"type": "boolean"
},
"is_superuser": {
"description": "Is this user a superuser",
"title": "Superuser",
"type": "boolean"
},
"last_name": {
"description": "Last name of the user",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUserProfile"
}
],
"readOnly": true
},
"username": {
"description": "Username",
"type": "string"
}
},
"required": [
"email",
"first_name",
"groups",
"last_name",
"pk",
"profile",
"username"
],
"type": "object"
}
PATCH /api/user/{id}/set-password/¶
Description
Allows superusers to set the password for a user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"type": "object"
}
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"type": "object"
}
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"override_warning": true,
"password": "string"
}
Schema of the response body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"required": [
"password"
],
"type": "object"
}
PUT /api/user/{id}/set-password/¶
Description
Allows superusers to set the password for a user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"required": [
"password"
],
"type": "object"
}
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"required": [
"password"
],
"type": "object"
}
{
"override_warning": true,
"password": "string"
}
Schema of the request body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"required": [
"password"
],
"type": "object"
}
Response 200 OK
{
"override_warning": true,
"password": "string"
}
Schema of the response body
{
"description": "Serializer for setting a password for a user.",
"properties": {
"override_warning": {
"description": "Override the warning about password rules",
"type": "boolean",
"writeOnly": true
},
"password": {
"description": "Password for the user",
"type": "string",
"writeOnly": true
}
},
"required": [
"password"
],
"type": "object"
}
Schemas¶
ApiToken¶
| Name | Type |
|---|---|
active |
boolean |
created |
string(date-time) |
expiry |
string(date) |
id |
integer |
in_use |
boolean |
last_seen |
string(date)| null |
name |
string |
revoked |
boolean |
token |
string |
user |
integer |
user_detail |
BriefUserProfile¶
| Name | Type |
|---|---|
active |
boolean |
contact |
string| null |
displayname |
string| null |
location |
string| null |
organisation |
string| null |
position |
string| null |
primary_group |
integer| null |
status |
string| null |
type |
ExtendedUser¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
group_ids |
Array<integer> |
groups |
Array<Group> |
is_active |
boolean |
is_staff |
boolean |
is_superuser |
boolean |
last_name |
string |
pk |
integer |
profile |
|
username |
string |
GetAuthToken¶
| Name | Type |
|---|---|
expiry |
string(date) |
name |
string |
token |
string |
Group¶
| Name | Type |
|---|---|
name |
string |
permissions |
|
pk |
integer |
roles |
Array<RuleSet> |
users |
Array<User> |
MeUser¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
group_ids |
Array<integer> |
groups |
Array<Group> |
is_active |
boolean |
is_staff |
boolean |
is_superuser |
boolean |
last_name |
string |
pk |
integer |
profile |
|
username |
string |
NameEnum¶
Type: string
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer(int64)| null |
owner_model |
string |
pk |
integer |
PaginatedApiTokenList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ApiToken> |
PaginatedGroupList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Group> |
PaginatedOwnerList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Owner> |
PaginatedRuleSetList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<RuleSet> |
PaginatedUserCreateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<UserCreate> |
PatchedExtendedUser¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
group_ids |
Array<integer> |
groups |
Array<Group> |
is_active |
boolean |
is_staff |
boolean |
is_superuser |
boolean |
last_name |
string |
pk |
integer |
profile |
|
username |
string |
PatchedGroup¶
| Name | Type |
|---|---|
name |
string |
permissions |
|
pk |
integer |
roles |
Array<RuleSet> |
users |
Array<User> |
PatchedMeUser¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
group_ids |
Array<integer> |
groups |
Array<Group> |
is_active |
boolean |
is_staff |
boolean |
is_superuser |
boolean |
last_name |
string |
pk |
integer |
profile |
|
username |
string |
PatchedRuleSet¶
| Name | Type |
|---|---|
can_add |
boolean |
can_change |
boolean |
can_delete |
boolean |
can_view |
boolean |
group |
integer |
label |
string |
name |
|
pk |
integer |
PatchedUserProfile¶
| Name | Type |
|---|---|
active |
boolean |
contact |
string| null |
displayname |
string| null |
language |
string| null |
location |
string| null |
organisation |
string| null |
position |
string| null |
primary_group |
integer| null |
status |
string| null |
theme |
|
type |
|
widgets |
PatchedUserSetPassword¶
| Name | Type |
|---|---|
override_warning |
boolean |
password |
string |
Role¶
| Name | Type |
|---|---|
is_staff |
boolean |
is_superuser |
boolean |
permissions |
|
roles |
|
user |
integer |
username |
string |
RuleSet¶
| Name | Type |
|---|---|
can_add |
boolean |
can_change |
boolean |
can_delete |
boolean |
can_view |
boolean |
group |
integer |
label |
string |
name |
|
pk |
integer |
User¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
last_name |
string |
pk |
integer |
username |
string |
UserCreate¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
group_ids |
Array<integer> |
groups |
Array<Group> |
is_active |
boolean |
is_staff |
boolean |
is_superuser |
boolean |
last_name |
string |
pk |
integer |
profile |
|
username |
string |
UserProfile¶
| Name | Type |
|---|---|
active |
boolean |
contact |
string| null |
displayname |
string| null |
language |
string| null |
location |
string| null |
organisation |
string| null |
position |
string| null |
primary_group |
integer| null |
status |
string| null |
theme |
|
type |
|
widgets |
UserSetPassword¶
| Name | Type |
|---|---|
override_warning |
boolean |
password |
string |
UserTypeEnum¶
Type: string
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org