The Settings Management section of the InvenTree API schema is documented below.
InvenTree API 327¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
settings¶
GET /api/settings/global/¶
Description
API endpoint for accessing a list of global settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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. | |
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": [
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "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/GlobalSettings"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PATCH /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PUT /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
GET /api/settings/notification/¶
Description
API endpoint for accessing a list of notification user settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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. | |
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": [
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "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/NotificationUserSetting"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PATCH /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PUT /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"method": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"method",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
GET /api/settings/user/¶
Description
API endpoint for accessing a list of user settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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. | |
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": [
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "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/UserSettings"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PATCH /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PUT /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
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" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Schemas¶
GlobalSettings¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_name |
string| null |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
value |
string| null |
NotificationUserSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
method |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string| null |
PaginatedGlobalSettingsList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<GlobalSettings> |
PaginatedNotificationUserSettingList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<NotificationUserSetting> |
PaginatedUserSettingsList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<UserSettings> |
PatchedGlobalSettings¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_name |
string| null |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
value |
string| null |
PatchedNotificationUserSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
method |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string| null |
PatchedUserSettings¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_name |
string| null |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
user |
integer |
value |
string| null |
UserSettings¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_name |
string| null |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
user |
integer |
value |
string| null |
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": "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": "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": "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.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.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": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
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.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,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"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.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.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 | ||
| 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