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

InvenTree API 303

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

application/json

{
    "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 201 Created

application/json

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/json

{
    "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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

application/json

{
    "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

application/json

{
    "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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

application/json

{
    "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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

application/json

{
    "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

application/json

{
    "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "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": "API serializer specifically for the 'me' endpoint.",
    "properties": {
        "email": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/json

{
    "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

application/json

{
    "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

API endpoint which lists the available role permissions for 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

application/json

{
    "is_staff": true,
    "is_superuser": true,
    "permissions": {},
    "roles": {},
    "user": 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 roles associated with a given user.",
    "properties": {
        "is_staff": {
            "description": "Designates whether the user can log into this admin site.",
            "title": "Staff status",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Designates that this user has all permissions without explicitly assigning them.",
            "title": "Superuser status",
            "type": "boolean"
        },
        "permissions": {
            "additionalProperties": {},
            "description": "Permissions associated with the user.",
            "readOnly": true,
            "type": "object"
        },
        "roles": {
            "additionalProperties": {},
            "description": "Roles associated with the user.",
            "readOnly": true,
            "type": "object"
        },
        "user": {
            "type": "integer"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "pattern": "^[\\w.@+-]+$",
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "roles",
        "user",
        "username"
    ],
    "type": "object"
}

---

GET /api/user/token/

Description

Return an API token if the user is authenticated.

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

Input parameters

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

Description

List of registered tokens for current 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"

Response 204 No Content

---

GET /api/user/tokens/

Description

List of registered tokens for current 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"
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

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "active": "string",
            "created": "2022-04-13T15:42:05.901Z",
            "expiry": "2022-04-13",
            "id": 0,
            "in_use": true,
            "last_seen": "2022-04-13",
            "name": "string",
            "revoked": true,
            "token": "string",
            "user": 0
        }
    ]
}

⚠️ 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/ApiToken"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

DELETE /api/user/tokens/{id}/

Description

List of registered tokens for current 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"
id	path	integer		No

Response 204 No Content

---

GET /api/user/tokens/{id}/

Description

List of registered tokens for current 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"
id	path	integer		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.

Response 200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "active": "string",
            "created": "2022-04-13T15:42:05.901Z",
            "expiry": "2022-04-13",
            "id": 0,
            "in_use": true,
            "last_seen": "2022-04-13",
            "name": "string",
            "revoked": true,
            "token": "string",
            "user": 0
        }
    ]
}

⚠️ 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/ApiToken"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

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

application/json

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "pk",
        "username"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "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": {
            "description": "Email address of the user",
            "format": "email",
            "type": "string"
        },
        "first_name": {
            "description": "First name of the user",
            "type": "string"
        },
        "groups": {
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "readOnly": true,
            "type": "array"
        },
        "is_active": {
            "description": "Is this user account active",
            "title": "Active",
            "type": "boolean"
        },
        "is_staff": {
            "description": "Does this user have staff permissions",
            "title": "Staff",
            "type": "boolean"
        },
        "is_superuser": {
            "description": "Is this user a superuser",
            "title": "Superuser",
            "type": "boolean"
        },
        "last_name": {
            "description": "Last name of the user",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "username": {
            "description": "Username",
            "type": "string"
        }
    },
    "required": [
        "email",
        "first_name",
        "groups",
        "is_active",
        "is_staff",
        "is_superuser",
        "last_name",
        "pk",
        "username"
    ],
    "type": "object"
}

---

Schemas

ApiToken

Name	Type
active	string
created	string(date-time)
expiry	string(date)
id	integer
in_use	boolean
last_seen	string(date)| null
name	string
revoked	boolean
token	string
user	integer

ExtendedUser

Name	Type
email	string(email)
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

MeUser

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

Owner

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

PaginatedApiTokenList

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

PaginatedGroupList

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

PaginatedOwnerList

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

PaginatedUserCreateList

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

PatchedExtendedUser

Name	Type
email	string(email)
first_name	string
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

PatchedMeUser

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

Role

Name	Type
is_staff	boolean
is_superuser	boolean
permissions
roles
user	integer
username	string

UserCreate

Name	Type
email	string(email)
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