v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB

Users

Update a User

Update an existing user

patch/users/{id}

Path parameters

idstring required

Example:8cbb43fe-4cdf-4991-8352-c461779cec02

Unique identifier for the object.

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

idstring

Unique identifier for the user.

first_namestring

First name of the user.

last_namestring

Last name of the user.

emailstring email

Unique email address for the user.

passwordstring

Password of the user.

locationstring nullable

The user's location.

titlestring nullable

The user's title.

descriptionstring nullable

The user's description.

tagsstring[] nullable

The user's tags.

languagestring

The user's language used in Directus.

tfa_secretstring nullable

The 2FA secret string that's used to generate one time passwords.

status'active' | 'invited' | 'draft' | 'suspended' | 'deleted'

Status of the user.

tokenstring nullable

Static token for the user.

last_accessstring date-time nullable

When this user used the API last.

last_pagestring nullable

Last page that the user was on.

providerstring

external_identifierstring nullable

{"stackTrail":"components:schemas:Users:properties:auth_data","oasType":"schema","type":"unknown","nullable":true}

email_notificationsboolean nullable

appearancestring nullable

theme_darkstring nullable

theme_lightstring nullable

{"stackTrail":"components:schemas:Users:properties:theme_light_overrides","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:Users:properties:theme_dark_overrides","oasType":"schema","type":"unknown","nullable":true}

text_directionstring

{"stackTrail":"components:schemas:Users:properties:policies","oasType":"schema","type":"unknown","nullable":true}

Response

Successful request

dataobject