Skip to main content
POST
UpdateUser

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
user
user · object
required

RustAuth's user model. The native authentication ID is the application user ID.

updateMask
string

Comma-separated field paths in lowerCamelCase (for example, user.displayName,photo).

Response

Success

RustAuth's user model. The native authentication ID is the application user ID.

id
string
name
string
Maximum string length: 256
email
string
Maximum string length: 254
emailVerified
boolean
image
string | null
username
string | null
displayUsername
string | null
createdAt
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

updatedAt
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

banned
boolean | null

RustAuth's admin plugin fields, matching the generated users table.

banReason
string | null
banExpires
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"