Skip to content

Update current user's profile

PUT
/v1/users/me/profile
curl --request PUT \
--url https://example.com/v1/users/me/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--data '{ "first_name": "example", "last_name": "example", "display_name": "example", "avatar_base64": "example" }'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Media type application/json
object
first_name
string
<= 100 characters
last_name
string
<= 100 characters
display_name
string
<= 100 characters
avatar_base64

Base64-encoded image data with data URI prefix, or null to remove

string
nullable
Example generated
{
"first_name": "example",
"last_name": "example",
"display_name": "example",
"avatar_base64": "example"
}

OK

Media type application/json
object
id
required
string format: uuid
email
required
string
name
required
string
auth_provider
required

When oidc/saml, first_name/last_name/email are managed by IdP and read-only

string
Allowed values: local oidc saml
first_name
string
nullable
last_name
string
nullable
display_name
string
nullable
avatar_base64

Base64-encoded image data with data URI prefix (max ~256KB)

string
nullable
Example
{
"auth_provider": "local"
}

Invalid input (avatar too large, SSO-managed fields)

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}