Skip to content

The User Management section of the InvenTree API schema is documented below.

InvenTree API 198

API for InvenTree - the intuitive open source inventory management system


License: MIT

Servers

Description URL
http://localhost:8000 http://localhost:8000

user


GET /api/user/

Description

List endpoint for detail on all users.

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"
is_active query boolean No
is_staff query boolean No
is_superuser query boolean No
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "email": "derp@meme.org",
            "first_name": "string",
            "groups": [
                {
                    "name": "string",
                    "pk": 0
                }
            ],
            "is_active": true,
            "is_staff": true,
            "is_superuser": true,
            "last_name": "string",
            "pk": 0,
            "username": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/UserCreate"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/user/

Description

List endpoint for detail on all users.

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"

Request body

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for creating a new User.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for creating a new User.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for creating a new User.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 201 Created

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for creating a new User.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

GET /api/user/group/

Description

List endpoint for all auth groups.

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": [
        {
            "name": "string",
            "pk": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/user/group/

Description

List endpoint for all auth groups.

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"

Request body

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

DELETE /api/user/group/{id}/

Description

Detail endpoint for a particular auth group.

Input parameters

Parameter In Type Default Nullable Description
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 string No

Response 204 No Content


GET /api/user/group/{id}/

Description

Detail endpoint for a particular auth group.

Input parameters

Parameter In Type Default Nullable Description
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 string No

Response 200 OK

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

PATCH /api/user/group/{id}/

Description

Detail endpoint for a particular auth group.

Input parameters

Parameter In Type Default Nullable Description
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 string No

Request body

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

PUT /api/user/group/{id}/

Description

Detail endpoint for a particular auth group.

Input parameters

Parameter In Type Default Nullable Description
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 string No

Request body

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

{
    "name": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a 'Group'.",
    "properties": {
        "name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "pk"
    ],
    "type": "object"
}

DELETE /api/user/me/

Description

Detail endpoint for current user.

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"

Response 204 No Content


GET /api/user/me/

Description

Detail endpoint for current user.

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"

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

PATCH /api/user/me/

Description

Detail endpoint for current user.

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"

Request body

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

PUT /api/user/me/

Description

Detail endpoint for current user.

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"

Request body

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

GET /api/user/owner/

Description

List API endpoint for Owner model.

Cannot create.

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.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "label": "string",
            "name": "string",
            "owner_id": 0,
            "pk": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/Owner"
            },
            "type": "array"
        }
    },
    "type": "object"
}

GET /api/user/owner/{id}/

Description

Detail API endpoint for Owner model.

Cannot edit or delete

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "label": "string",
    "name": "string",
    "owner_id": 0,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for an \"Owner\" (either a \"user\" or a \"group\").",
    "properties": {
        "label": {
            "readOnly": true,
            "type": "string"
        },
        "name": {
            "readOnly": true,
            "type": "string"
        },
        "owner_id": {
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

GET /api/user/roles/

Description

Return the list of roles / permissions available to the current user.

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"

Response 200 OK


GET /api/user/token/

Description

Return an API token if the user is authenticated.

  • If the user already has a matching token, delete it and create a new one
  • Existing tokens are never exposed again via the API
  • Once the token is provided, it can be used for auth until it expires

Input parameters

Parameter In Type Default Nullable Description
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


DELETE /api/user/{id}/

Description

Detail endpoint for a single user.

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 string No

Response 204 No Content


GET /api/user/{id}/

Description

Detail endpoint for a single user.

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 string No

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

PATCH /api/user/{id}/

Description

Detail endpoint for a single user.

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 string No

Request body

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

PUT /api/user/{id}/

Description

Detail endpoint for a single user.

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 string No

Request body

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 200 OK

{
    "email": "derp@meme.org",
    "first_name": "string",
    "groups": [
        {
            "name": "string",
            "pk": 0
        }
    ],
    "is_active": true,
    "is_staff": true,
    "is_superuser": true,
    "last_name": "string",
    "pk": 0,
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a User with a bit more info.",
    "properties": {
        "email": {
            "format": "email",
            "maxLength": 254,
            "title": "Email address",
            "type": "string"
        },
        "first_name": {
            "maxLength": 150,
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "last_name": {
            "maxLength": 150,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "groups",
        "pk",
        "username"
    ],
    "type": "object"
}

Schemas

ExendedUser

Name Type
email string()
first_name string
groups Array<Group>
is_active boolean
is_staff boolean
is_superuser boolean
last_name string
pk integer
username string

Group

Name Type
name string
pk integer

Owner

Name Type
label string
name string
owner_id integer| null
pk integer

PaginatedGroupList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<Group>

PaginatedOwnerList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<Owner>

PaginatedUserCreateList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<UserCreate>

PatchedExendedUser

Name Type
email string()
first_name string
groups Array<Group>
is_active boolean
is_staff boolean
is_superuser boolean
last_name string
pk integer
username string

PatchedGroup

Name Type
name string
pk integer

UserCreate

Name Type
email string()
first_name string
groups Array<Group>
is_active boolean
is_staff boolean
is_superuser boolean
last_name string
pk integer
username string

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