v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Organization Users

Create User

Create a new organization user.

post/v1/organizations/users

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 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

Custom key/value metadata stored with the user record.

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

Successful Response

object required