Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
users
v1

Update User

put/api/v1/users/users/{id}/

Path parameters

idstring required

A unique integer value identifying this user.

Request body

uidstring uuid
usernamestring

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

last_namestring
first_namestring
namestring
initialsstring
photostring binary nullable
emailstring email
organizationstring nullable
groupsinteger[]

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Example request

{
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "initials": "initials",
  "organization": "organization",
  "name": "name",
  "last_name": "last_name",
  "photo": "",
  "groups": [
    0,
    0
  ],
  "first_name": "first_name",
  "email": "email",
  "username": "username"
}

Response

uidstring uuid
usernamestring

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

last_namestring
first_namestring
namestring
initialsstring
photostring binary nullable
emailstring email
organizationstring nullable
groupsinteger[]

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Example response

{
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "initials": "initials",
  "organization": "organization",
  "name": "name",
  "last_name": "last_name",
  "photo": "",
  "groups": [
    0,
    0
  ],
  "first_name": "first_name",
  "email": "email",
  "username": "username"
}