Update User

curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations/users/{user_email} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_name": "<string>",
  "role": "admin",
  "status": "active",
  "metadata": {}
}
'

{
  "internal_id": "<string>",
  "organization_id": "<string>",
  "email": "[email protected]",
  "user_name": "<string>",
  "user_id": "<string>",
  "role": "member",
  "status": "active",
  "metadata": {},
  "namespace_permissions": [
    {
      "namespace_id": "<string>",
      "role": "member",
      "operations": [
        "read_data"
      ],
      "granted_at": "2023-11-07T05:31:56Z",
      "granted_by": "usr_a1b2c3d4e5f6g7"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z"
}

PATCH

organizations

users

{user_email}

Update User

curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations/users/{user_email} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_name": "<string>",
  "role": "admin",
  "status": "active",
  "metadata": {}
}
'

{
  "internal_id": "<string>",
  "organization_id": "<string>",
  "email": "[email protected]",
  "user_name": "<string>",
  "user_id": "<string>",
  "role": "member",
  "status": "active",
  "metadata": {},
  "namespace_permissions": [
    {
      "namespace_id": "<string>",
      "role": "member",
      "operations": [
        "read_data"
      ],
      "granted_at": "2023-11-07T05:31:56Z",
      "granted_by": "usr_a1b2c3d4e5f6g7"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z"
}

Headers

Authorization

string

required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Path Parameters

user_email

string

required

Body

application/json

Partial update payload for a user.

user_name

string | null

Updated display name.

Required string length: 2 - 100

role

enum<string> | null

Updated organization role.

Available options:

admin,

member,

viewer

status

enum<string> | null

Lifecycle status update (active, suspended, pending).

Available options:

active,

suspended,

pending

metadata

Metadata · object

Replaces metadata with the provided dictionary when set.

Response

Successful Response

Canonical user document persisted in MongoDB.

internal_id

string

required

Organization internal identifier used for scoping queries.

organization_id

string

required

Organization public identifier for reference in APIs.

string<email>

required

Unique email address for the user.

user_name

string

required

Display name shown in UI and logs.

user_id

string

Immutable public identifier for the user.

role

enum<string>

default:member

Organization role controlling UI access levels.

Available options:

admin,

member,

viewer

status

enum<string>

default:active

Lifecycle status of the account.

Available options:

active,

suspended,

pending

metadata

Metadata · object

Arbitrary metadata stored alongside the user record.

namespace_permissions

NamespacePermissions · object[]

Namespace-level roles applied across all of the user's keys.

Show child attributes

namespace_permissions.namespace_id

string

required

Namespace this permission applies to (e.g. 'ns_production').

namespace_permissions.role

enum<string>

default:member

User's baseline role inside the namespace.

Available options:

owner,

admin,

member,

viewer

namespace_permissions.operations

enum<string>[] | null

Optional explicit operations granted within the namespace.When omitted, the role's defaults apply.

Granular operations that can be scoped inside a namespace.

These operations are used to define fine-grained permissions for API keys and users within specific namespaces. Operations can be granted individually or in combination to implement least-privilege access control.

Data operations: - READ_DATA: View and search documents, retrieve objects from buckets - WRITE_DATA: Create and update documents, upload objects to buckets - DELETE_DATA: Remove documents and objects permanently

Retrieval operations: - EXECUTE_RETRIEVER: Run search queries using configured retrievers - CREATE_RETRIEVER: Define new retrieval pipelines with custom stages - DELETE_RETRIEVER: Remove retrieval pipeline configurations

Job execution: - EXECUTE_JOB: Trigger ingestion pipelines and batch processing jobs - CANCEL_JOB: Abort running jobs before completion

Cluster management (Ray infrastructure): - CREATE_CLUSTER: Provision new Ray compute clusters - DELETE_CLUSTER: Tear down existing compute clusters - MODIFY_CLUSTER: Scale or reconfigure running clusters

Infrastructure configuration: - MODIFY_INFRASTRUCTURE: Change namespace settings, storage connections - MANAGE_PERMISSIONS: Grant and revoke user access within the namespace

Examples: - Read-only access: [READ_DATA, EXECUTE_RETRIEVER] - Data engineer access: [READ_DATA, WRITE_DATA, EXECUTE_JOB] - Full namespace admin: All operations granted

Available options:

read_data,

write_data,

delete_data,

execute_retriever,

create_retriever,

delete_retriever,

execute_job,

cancel_job,

create_cluster,

delete_cluster,

modify_cluster,

modify_infrastructure,

manage_permissions

namespace_permissions.granted_at

string<date-time>

UTC timestamp when this namespace access was granted.

namespace_permissions.granted_by

string | null

User identifier that granted this namespace permission.

Example:

"usr_a1b2c3d4e5f6g7"

created_at

string<date-time>

UTC timestamp when the user was created.

updated_at

string<date-time>

UTC timestamp of the latest update to the user.

UTC timestamp of the last successful login.

Get User Delete User

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

Update User

Headers

Path Parameters

Body

Response