core_users_update

PUT 
/api/v3//core/users/:id/

User Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this User.

application/json

Bodyrequired

usernamestringrequired

Possible values: non-empty and <= 150 characters

namestringrequired

User's display name.

is_activeActive (boolean)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_logindate-timenullable

groupsuuid[]

emailemail

Possible values: <= 254 characters

attributes object

property name*any

pathstring

Possible values: non-empty

typeUserTypeEnum (string)

Possible values: [internal, external, service_account, internal_service_account]

Responses

200

application/json

Schema

Schema

pkID (integer)required
usernamestringrequired
Possible values: <= 150 characters
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
is_superuserbooleanrequired
groupsuuid[]
groups_obj object[]nullablerequired
Array [
pkuuidrequired
num_pkintegerrequired
Get a numerical, int32 ID for the group
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
attributes object
property name*any
]
emailemail
Possible values: <= 254 characters
avatarstringrequired
User's avatar, either a http/https URL or a data URI
attributes object
property name*any
uidstringrequired
pathstring
typeUserTypeEnum (string)
Possible values: [internal, external, service_account, internal_service_account]
uuiduuidrequired
password_change_datedate-timerequired

Example (auto)

{
  "pk": 0,
  "username": "string",
  "name": "string",
  "is_active": true,
  "last_login": "2024-07-29T15:51:28.071Z",
  "is_superuser": true,
  "groups": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "groups_obj": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "num_pk": 0,
      "name": "string",
      "is_superuser": true,
      "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parent_name": "string",
      "attributes": {}
    }
  ],
  "email": "user@example.com",
  "avatar": "string",
  "attributes": {},
  "uid": "string",
  "path": "string",
  "type": "internal",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password_change_date": "2024-07-29T15:51:28.071Z"
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "username": "string",
  "name": "string",
  "is_active": true,
  "last_login": "2024-07-29T15:51:28.071Z",
  "groups": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "email": "user@example.com",
  "attributes": {},
  "path": "string",
  "type": "internal"
}