Users

Users:User

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idanyRequired

Responses

200

Successful Response

application/json

Base User model.

idanyOptional

emailstring · emailRequired

is_activebooleanOptionalDefault: true

is_superuserbooleanOptionalDefault: false

is_verifiedbooleanOptionalDefault: false

401

Missing token or inactive user.

403

Not a superuser.

404

The user does not exist.

422

Validation Error

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /users/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": null,
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false
}

Users:Delete User

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idanyRequired

Responses

204

Successful Response

401

Missing token or inactive user.

403

Not a superuser.

404

The user does not exist.

422

Validation Error

application/json

delete

/users/{id}

HTTPcURLJavaScriptPython

DELETE /users/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Users:Patch User

patch

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idanyRequired

Body

application/json

passwordstringOptional

emailstring · emailOptional

is_activebooleanOptional

is_superuserbooleanOptional

is_verifiedbooleanOptional

Responses

200

Successful Response

application/json

Base User model.

idanyOptional

emailstring · emailRequired

is_activebooleanOptionalDefault: true

is_superuserbooleanOptionalDefault: false

is_verifiedbooleanOptionalDefault: false

400

Bad Request

application/json

401

Missing token or inactive user.

403

Not a superuser.

404

The user does not exist.

422

Validation Error

application/json

patch

/users/{id}

HTTPcURLJavaScriptPython

PATCH /users/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "password": "text",
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true
}

{
  "id": null,
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false
}