The Plugin Functionality 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 |
plugins¶
GET /api/plugins/¶
Description
API endpoint for list of PluginConfig objects.
- GET: Return a list of all PluginConfig objects
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" |
active |
query | boolean | No | ||
builtin |
query | boolean | No | Builtin | |
installed |
query | boolean | No | Installed | |
limit |
query | integer | No | Number of results to return per page. | |
mandatory |
query | boolean | No | Mandatory | |
mixin |
query | string | No | Mixin | |
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. | |
sample |
query | boolean | No | Sample | |
search |
query | string | No | A search term. Searched fields: key, 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": [
{
"active": true,
"is_builtin": true,
"is_installed": true,
"is_mandatory": true,
"is_package": true,
"is_sample": true,
"key": "string",
"meta": {},
"mixins": {},
"name": "string",
"package_name": "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/PluginConfig"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/plugins/install/¶
Description
Endpoint for installing a new plugin.
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
{
"confirm": true,
"packagename": "string",
"url": "string",
"version": "string"
}
Schema of the request body
{
"description": "Serializer for installing a new plugin.",
"properties": {
"confirm": {
"description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
"title": "Confirm plugin installation",
"type": "boolean"
},
"packagename": {
"description": "Name for the Plugin Package - can also contain a version indicator",
"title": "Package Name",
"type": "string"
},
"url": {
"description": "Source for the package - this can be a custom registry or a VCS path",
"title": "Source URL",
"type": "string"
},
"version": {
"description": "Version specifier for the plugin. Leave blank for latest version.",
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
}
{
"confirm": true,
"packagename": "string",
"url": "string",
"version": "string"
}
Schema of the request body
{
"description": "Serializer for installing a new plugin.",
"properties": {
"confirm": {
"description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
"title": "Confirm plugin installation",
"type": "boolean"
},
"packagename": {
"description": "Name for the Plugin Package - can also contain a version indicator",
"title": "Package Name",
"type": "string"
},
"url": {
"description": "Source for the package - this can be a custom registry or a VCS path",
"title": "Source URL",
"type": "string"
},
"version": {
"description": "Version specifier for the plugin. Leave blank for latest version.",
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
}
{
"confirm": true,
"packagename": "string",
"url": "string",
"version": "string"
}
Schema of the request body
{
"description": "Serializer for installing a new plugin.",
"properties": {
"confirm": {
"description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
"title": "Confirm plugin installation",
"type": "boolean"
},
"packagename": {
"description": "Name for the Plugin Package - can also contain a version indicator",
"title": "Package Name",
"type": "string"
},
"url": {
"description": "Source for the package - this can be a custom registry or a VCS path",
"title": "Source URL",
"type": "string"
},
"version": {
"description": "Version specifier for the plugin. Leave blank for latest version.",
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
}
Response 201 Created
{
"confirm": true,
"packagename": "string",
"url": "string",
"version": "string"
}
Schema of the response body
{
"description": "Serializer for installing a new plugin.",
"properties": {
"confirm": {
"description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
"title": "Confirm plugin installation",
"type": "boolean"
},
"packagename": {
"description": "Name for the Plugin Package - can also contain a version indicator",
"title": "Package Name",
"type": "string"
},
"url": {
"description": "Source for the package - this can be a custom registry or a VCS path",
"title": "Source URL",
"type": "string"
},
"version": {
"description": "Version specifier for the plugin. Leave blank for latest version.",
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
}
POST /api/plugins/reload/¶
Description
Endpoint for reloading all plugins.
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
{
"collect_plugins": true,
"force_reload": true,
"full_reload": true
}
Schema of the request body
{
"description": "Serializer for remotely forcing plugin registry reload.",
"properties": {
"collect_plugins": {
"default": false,
"description": "Collect plugins and add them to the registry",
"type": "boolean"
},
"force_reload": {
"default": false,
"description": "Force a reload of the plugin registry, even if it is already loaded",
"type": "boolean"
},
"full_reload": {
"default": false,
"description": "Perform a full reload of the plugin registry",
"type": "boolean"
}
},
"type": "object"
}
{
"collect_plugins": true,
"force_reload": true,
"full_reload": true
}
Schema of the request body
{
"description": "Serializer for remotely forcing plugin registry reload.",
"properties": {
"collect_plugins": {
"default": false,
"description": "Collect plugins and add them to the registry",
"type": "boolean"
},
"force_reload": {
"default": false,
"description": "Force a reload of the plugin registry, even if it is already loaded",
"type": "boolean"
},
"full_reload": {
"default": false,
"description": "Perform a full reload of the plugin registry",
"type": "boolean"
}
},
"type": "object"
}
{
"collect_plugins": true,
"force_reload": true,
"full_reload": true
}
Schema of the request body
{
"description": "Serializer for remotely forcing plugin registry reload.",
"properties": {
"collect_plugins": {
"default": false,
"description": "Collect plugins and add them to the registry",
"type": "boolean"
},
"force_reload": {
"default": false,
"description": "Force a reload of the plugin registry, even if it is already loaded",
"type": "boolean"
},
"full_reload": {
"default": false,
"description": "Perform a full reload of the plugin registry",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"collect_plugins": true,
"force_reload": true,
"full_reload": true
}
Schema of the response body
{
"description": "Serializer for remotely forcing plugin registry reload.",
"properties": {
"collect_plugins": {
"default": false,
"description": "Collect plugins and add them to the registry",
"type": "boolean"
},
"force_reload": {
"default": false,
"description": "Force a reload of the plugin registry, even if it is already loaded",
"type": "boolean"
},
"full_reload": {
"default": false,
"description": "Perform a full reload of the plugin registry",
"type": "boolean"
}
},
"type": "object"
}
GET /api/plugins/settings/¶
Description
List endpoint for all plugin related settings.
- read only
- only accessible by staff users
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. | |
plugin__active |
query | boolean | No | ||
plugin__key |
query | string | 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": [
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"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/PluginSetting"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/plugins/status/¶
Description
Show plugin registry status information.
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_plugins": 0,
"registry_errors": [
{
"message": "string",
"name": "string",
"stage": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for plugin registry status.",
"properties": {
"active_plugins": {
"readOnly": true,
"type": "integer"
},
"registry_errors": {
"items": {
"$ref": "#/components/schemas/PluginRegistryError"
},
"type": "array"
}
},
"required": [
"active_plugins",
"registry_errors"
],
"type": "object"
}
GET /api/plugins/ui/features/{feature}/¶
Description
Show available plugin ui features.
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" |
feature |
path | string | No |
Response 200 OK
[
{
"context": {},
"description": "string",
"feature_type": "string",
"icon": "string",
"key": "string",
"options": {},
"plugin_name": "string",
"source": "string",
"title": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/PluginUIFeature"
},
"type": "array"
}
DELETE /api/plugins/{plugin}/¶
Description
Handle DELETE request for a PluginConfig instance.
We only allow plugin deletion if the plugin is not active.
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" |
plugin |
path | string | No |
Response 204 No Content
GET /api/plugins/{plugin}/¶
Description
API detail endpoint for PluginConfig object.
get: Return a single PluginConfig object
post: Update a PluginConfig
delete: Remove a PluginConfig
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" |
plugin |
path | string | No |
Response 200 OK
{
"active": true,
"is_builtin": true,
"is_installed": true,
"is_mandatory": true,
"is_package": true,
"is_sample": true,
"key": "string",
"meta": {},
"mixins": {},
"name": "string",
"package_name": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PluginConfig.",
"properties": {
"active": {
"description": "Is the plugin active",
"type": "boolean"
},
"is_builtin": {
"description": "Return True if this is a 'builtin' plugin.",
"readOnly": true,
"type": "boolean"
},
"is_installed": {
"description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
"readOnly": true,
"type": "boolean"
},
"is_mandatory": {
"readOnly": true,
"type": "boolean"
},
"is_package": {
"description": "Return True if this is a 'package' plugin.",
"readOnly": true,
"type": "boolean"
},
"is_sample": {
"description": "Is this plugin a sample app?",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "Key of plugin",
"readOnly": true,
"type": "string"
},
"meta": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"mixins": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"name": {
"description": "PluginName of the plugin",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"package_name": {
"description": "Name of the installed package, if the plugin was installed via PIP",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"is_builtin",
"is_installed",
"is_mandatory",
"is_package",
"is_sample",
"key",
"meta",
"mixins",
"pk"
],
"type": "object"
}
PATCH /api/plugins/{plugin}/activate/¶
Description
Endpoint for activating a plugin.
- PATCH: Activate a plugin
Pass a boolean value for the 'active' field. If not provided, it is assumed to be True, and the plugin will be activated.
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" |
plugin |
path | string | No |
Request body
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"active": true
}
Schema of the response body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
PUT /api/plugins/{plugin}/activate/¶
Description
Endpoint for activating a plugin.
- PATCH: Activate a plugin
Pass a boolean value for the 'active' field. If not provided, it is assumed to be True, and the plugin will be activated.
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" |
plugin |
path | string | No |
Request body
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
{
"active": true
}
Schema of the request body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"active": true
}
Schema of the response body
{
"description": "Serializer for activating or deactivating a plugin.",
"properties": {
"active": {
"default": true,
"description": "Activate this plugin",
"title": "Activate Plugin",
"type": "boolean"
}
},
"type": "object"
}
GET /api/plugins/{plugin}/admin/¶
Description
Endpoint for viewing admin integration plugin details.
This endpoint is used to view the available admin integration options for a plugin.
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" |
plugin |
path | string | No |
Response 200 OK
{
"context": null,
"source": "string"
}
Schema of the response body
{
"description": "Serializer for a PluginConfig with admin details.",
"properties": {
"context": {
"description": "Optional context data for the admin integration",
"nullable": true
},
"source": {
"description": "Path to the source file for admin integration",
"nullable": true,
"title": "Source File",
"type": "string"
}
},
"required": [
"context",
"source"
],
"type": "object"
}
GET /api/plugins/{plugin}/metadata/¶
Description
Metadata API endpoint for the PluginConfig model.
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" |
plugin |
path | string | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/plugins/{plugin}/metadata/¶
Description
Metadata API endpoint for the PluginConfig model.
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" |
plugin |
path | string | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/plugins/{plugin}/metadata/¶
Description
Metadata API endpoint for the PluginConfig model.
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" |
plugin |
path | string | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/plugins/{plugin}/settings/¶
Description
Get all settings for a plugin config.
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" |
plugin |
path | string | No |
Response 200 OK
[
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/PluginSetting"
},
"type": "array"
}
GET /api/plugins/{plugin}/settings/{key}/¶
Description
Detail endpoint for a plugin-specific setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PATCH /api/plugins/{plugin}/settings/{key}/¶
Description
Detail endpoint for a plugin-specific setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PUT /api/plugins/{plugin}/settings/{key}/¶
Description
Detail endpoint for a plugin-specific setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "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"
},
"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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PATCH /api/plugins/{plugin}/uninstall/¶
Description
Endpoint for uninstalling a single plugin.
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" |
plugin |
path | string | No |
Request body
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"delete_config": true
}
Schema of the response body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
PUT /api/plugins/{plugin}/uninstall/¶
Description
Endpoint for uninstalling a single plugin.
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" |
plugin |
path | string | No |
Request body
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
{
"delete_config": true
}
Schema of the request body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"delete_config": true
}
Schema of the response body
{
"description": "Serializer for uninstalling a plugin.",
"properties": {
"delete_config": {
"default": true,
"description": "Delete the plugin configuration from the database",
"title": "Delete configuration",
"type": "boolean"
}
},
"type": "object"
}
GET /api/plugins/{plugin}/user-settings/¶
Description
Get all user settings for a plugin config.
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" |
plugin |
path | string | No |
Response 200 OK
[
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/PluginUserSetting"
},
"type": "array"
}
GET /api/plugins/{plugin}/user-settings/{key}/¶
Description
Detail endpoint for a plugin-specific user setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PATCH /api/plugins/{plugin}/user-settings/{key}/¶
Description
Detail endpoint for a plugin-specific user setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PUT /api/plugins/{plugin}/user-settings/{key}/¶
Description
Detail endpoint for a plugin-specific user setting.
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" |
key |
path | string | No | ||
plugin |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"plugin": "string",
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginUserSetting 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_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"
},
"plugin": {
"readOnly": true,
"type": "string"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"description": "The user for which this setting applies",
"readOnly": true,
"type": "integer"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"description",
"key",
"model_filters",
"name",
"pk",
"plugin",
"required",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Schemas¶
Metadata¶
| Name | Type |
|---|---|
metadata |
PaginatedPluginConfigList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PluginConfig> |
PaginatedPluginSettingList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PluginSetting> |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
PatchedPluginActivate¶
| Name | Type |
|---|---|
active |
boolean |
PatchedPluginSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
plugin |
string |
required |
boolean |
typ |
string |
type |
string |
units |
string |
value |
string| null |
PatchedPluginUninstall¶
| Name | Type |
|---|---|
delete_config |
boolean |
PatchedPluginUserSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
plugin |
string |
required |
boolean |
typ |
string |
type |
string |
units |
string |
user |
integer |
value |
string| null |
PluginActivate¶
| Name | Type |
|---|---|
active |
boolean |
PluginAdminDetail¶
| Name | Type |
|---|---|
context |
|
source |
string| null |
PluginConfig¶
| Name | Type |
|---|---|
active |
boolean |
is_builtin |
boolean |
is_installed |
boolean |
is_mandatory |
boolean |
is_package |
boolean |
is_sample |
boolean |
key |
string |
meta |
|
mixins |
|
name |
string| null |
package_name |
string| null |
pk |
integer |
PluginConfigInstall¶
| Name | Type |
|---|---|
confirm |
boolean |
packagename |
string |
url |
string |
version |
string |
PluginRegistryError¶
| Name | Type |
|---|---|
message |
string |
name |
string |
stage |
string |
PluginRegistryStatus¶
| Name | Type |
|---|---|
active_plugins |
integer |
registry_errors |
Array<PluginRegistryError> |
PluginReload¶
| Name | Type |
|---|---|
collect_plugins |
boolean |
force_reload |
boolean |
full_reload |
boolean |
PluginSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
plugin |
string |
required |
boolean |
typ |
string |
type |
string |
units |
string |
value |
string| null |
PluginUIFeature¶
| Name | Type |
|---|---|
context |
|
description |
string |
feature_type |
string |
icon |
string |
key |
string |
options |
|
plugin_name |
string |
source |
string |
title |
string |
PluginUninstall¶
| Name | Type |
|---|---|
delete_config |
boolean |
PluginUserSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
plugin |
string |
required |
boolean |
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": "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