Sign in
Organization Users

Update User

Apply partial updates to an existing user.

patch/v1/organizations/users/{user_email}

Path parameters

user_emailstring required

Request body

user_namestring nullable

Updated display name.

avatar_urlstring nullable

Updated profile image URL (e.g., custom avatar to override Gravatar).

role'admin' | 'member' | 'viewer'

High-level organization role applied to users.

Roles define the baseline permissions a user has within an organization:

  • ADMIN: Full administrative access including user management, billing, and organization settings. Can create/modify/delete all resources.
  • MEMBER: Standard user access. Can create and manage their own resources (namespaces, collections, clusters) but cannot manage other users or organization-level settings.
  • VIEWER: Read-only access. Can view resources and execute retrievers but cannot create, modify, or delete any resources.
status'active' | 'suspended' | 'pending'

Lifecycle state of an organization user.

Status values control whether a user can authenticate and access resources:

  • ACTIVE: User is fully operational and can authenticate with their API keys.
  • SUSPENDED: User access is temporarily disabled. API keys will not work but account data is preserved. Can be reactivated by an admin.
  • PENDING: User invitation has been created but not yet accepted. User cannot authenticate until they complete the onboarding flow.
metadataobject nullable

Replaces metadata with the provided dictionary when set.

Response

Successful Response

object required

Changes

Changed in 1 of the 29 revisions of this API.1