users

Update the caller's own user record

Update the caller's own user record, proxied to the control plane. Authenticated only; the control plane resolves "me" from the asserted bearer. The body is forwarded verbatim, and the control plane validates it. Send If-Match: <etag> - the ETag from GET /users/me or a prior PATCH - to make the write conditional; a stale tag is 412. Without If-Match the write is last-writer-wins.

patch/registry/v1/users/me

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/users/me
  • Auth: HTTP bearer

Headers

If-Matchstring nullable

The profile's ETag from a prior read; makes the write conditional.

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

full_namestring required

The caller's new display name.

Response

The updated user record.

avatar_urlstring

The identity provider's picture for the caller, when it supplied one. Not the avatar uploaded through PUT /users/me/avatar.

emailstring required

The caller's email address.

full_namestring

The caller's display name, when they have one.

idstring required

The caller's control-plane user id.

onboarding_completed_atstring date-time

When the caller first completed onboarding in this organisation (RFC 3339). Absent if they never have.

org_idstring required

The organisation the caller's token is bound to.

provisioning'self_serve' | 'federated' | 'invited' required

How a user's account was created.

status'active' | 'invited' | 'suspended' | 'deprovisioned' | 'archived' required

A user's membership status in an organisation.

versioninteger required

The profile's optimistic-concurrency version.

Changes

No recorded changes to this operation across all 1 revision of this API.