Organization Users

Create User

Changed on

Create a new organization user.

post/v1/organizations/users

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/users
  • Auth: HTTP bearer

Request body

emailstring email required

Unique email address within the organization.

user_namestring required

Display name shown in dashboards and audit trails.

avatar_urlstring nullable

Profile picture URL (e.g., from PropelAuth picture_url property).

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 disabled. Setting this status revokes every API key the user owns, and no new key can be created for them while suspended. Account data is preserved. An admin can reactivate the user, who then creates new keys: the revoked keys stay revoked.
  • PENDING: User invitation has been created but not yet accepted. User cannot authenticate until they complete the onboarding flow.
metadataobject nullable

Custom key/value metadata stored with the user record.

Example request

{
  "email": "alice@example.com",
  "role": "member",
  "user_name": "Alice Smith"
}

Response

Successful Response

object required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API