Users

List Users Endpoint

get

List users.

Args: offset: Offset for pagination limit: Limit for pagination user_id: Filter by user ID oauth_provider: Filter by OAuth provider oauth_id: Filter by OAuth ID email: Filter by email is_active: Filter by active status user: Authorized user user_manager: User manager

Returns: List of users matching the filter criteria

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

user_idany ofOptional

string · uuidOptional

or

nullOptional

oauth_providerany ofOptional

stringOptional

or

nullOptional

oauth_idany ofOptional

stringOptional

or

nullOptional

emailany ofOptional

stringOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

User model for displaying user account and service account information.

This model is currently used for both user accounts and service accounts to ensure backward compatibility.

passwordany ofOptional

stringOptional

or

nullOptional

password_expiredany ofOptional

booleanOptional

or

nullOptional

nameany ofOptional

The name of the user.

string · min: 1 · max: 50Optional

or

nullOptional

avatar_urlany ofOptional

The avatar URL of the user.

stringOptional

or

nullOptional

companyany ofOptional

The company of the user.

string · min: 1 · max: 50Optional

or

nullOptional

job_titleany ofOptional

The job title of the user.

string · min: 1 · max: 50Optional

or

nullOptional

metadataany ofOptional

Additional metadata associated with the user.

or

nullOptional

idstring · uuidRequired

usernameany ofRequired

The unique username for the account. For OAuth2 user accounts, this is the same as the email address.

string · min: 1 · max: 50OptionalPattern: ^[a-zA-Z0-9_\-@.]+$

or

string · emailOptional

emailany ofOptional

The email address associated with the account. For OAuth2 user accounts, this is the unique identifier for the user and is also used as the username.

stringOptional

or

nullOptional

oauth_providerany ofOptional

The external OAuth2 provider that the user is associated with.

stringOptional

or

nullOptional

oauth_idany ofOptional

The external OAuth2 ID of the user.

stringOptional

or

nullOptional

is_activebooleanOptional

Whether the account is active.

Default: true

is_superuserbooleanOptional

Whether the account is a superuser.

Default: false

is_service_accountbooleanOptional

Whether the account is a service account.

Default: false

organization_idany ofOptional

The ID of the organization that the service account belongs to. Only set for service accounts.

string · uuidOptional

or

nullOptional

is_onboardedbooleanOptional

Whether the user has completed onboarding.

Default: false

422

Validation Error

application/json

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "password": "text",
    "password_expired": true,
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "email": "text",
    "oauth_provider": "text",
    "oauth_id": "text",
    "is_active": true,
    "is_superuser": false,
    "is_service_account": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_onboarded": false
  }
]

Delete User Endpoint

delete

Delete a user.

Args: user_id: User ID to delete user: Authenticated user user_manager: User manager workspace_manager: Workspace manager organization_manager: Organization manager

Raises: ValueError: If the user is internal. IllegalOperationError: If the operation is not allowed.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

user_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update User Endpoint

patch

Update a user.

Args: user_id: User ID user_update: User update user: Authenticated user user_manager: User manager

Returns: The updated user.

Raises: IllegalOperationError: If the operation is not allowed or the user does not exist.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

user_idstring · uuidRequired

Body

application/json

Model for user updates.

passwordany ofOptional

stringOptional

or

nullOptional

password_expiredany ofOptional

booleanOptional

or

nullOptional

nameany ofOptional

The name of the user.

string · min: 1 · max: 50Optional

or

nullOptional

avatar_urlany ofOptional

The avatar URL of the user.

stringOptional

or

nullOptional

companyany ofOptional

The company of the user.

string · min: 1 · max: 50Optional

or

nullOptional

job_titleany ofOptional

The job title of the user.

string · min: 1 · max: 50Optional

or

nullOptional

metadataany ofOptional

Additional metadata associated with the user.

or

nullOptional

usernameany ofOptional

New username for the user. Not possible to change the username for OAuth2 user accounts because it's the same as the email address provided by the external OAuth2 provider.

string · min: 1 · max: 50OptionalPattern: ^[a-zA-Z0-9_\-@.]+$

or

nullOptional

emailany ofOptional

New email address for the user. Not possible to change the email address for OAuth2 user accounts because it's the same as the email address provided by the external OAuth2 provider.

string · emailOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

is_onboardedany ofOptional

booleanOptional

or

nullOptional

is_superuserany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

User model for displaying user account and service account information.

This model is currently used for both user accounts and service accounts to ensure backward compatibility.

passwordany ofOptional

stringOptional

or

nullOptional

password_expiredany ofOptional

booleanOptional

or

nullOptional

nameany ofOptional

The name of the user.

string · min: 1 · max: 50Optional

or

nullOptional

avatar_urlany ofOptional

The avatar URL of the user.

stringOptional

or

nullOptional

companyany ofOptional

The company of the user.

string · min: 1 · max: 50Optional

or

nullOptional

job_titleany ofOptional

The job title of the user.

string · min: 1 · max: 50Optional

or

nullOptional

metadataany ofOptional

Additional metadata associated with the user.

or

nullOptional

idstring · uuidRequired

usernameany ofRequired

The unique username for the account. For OAuth2 user accounts, this is the same as the email address.

string · min: 1 · max: 50OptionalPattern: ^[a-zA-Z0-9_\-@.]+$

or

string · emailOptional

emailany ofOptional

The email address associated with the account. For OAuth2 user accounts, this is the unique identifier for the user and is also used as the username.

stringOptional

or

nullOptional

oauth_providerany ofOptional

The external OAuth2 provider that the user is associated with.

stringOptional

or

nullOptional

oauth_idany ofOptional

The external OAuth2 ID of the user.

stringOptional

or

nullOptional

is_activebooleanOptional

Whether the account is active.

Default: true

is_superuserbooleanOptional

Whether the account is a superuser.

Default: false

is_service_accountbooleanOptional

Whether the account is a service account.

Default: false

organization_idany ofOptional

The ID of the organization that the service account belongs to. Only set for service accounts.

string · uuidOptional

or

nullOptional

is_onboardedbooleanOptional

Whether the user has completed onboarding.

Default: false

422

Validation Error

application/json

patch

/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "password": "text",
  "password_expired": true,
  "name": "text",
  "avatar_url": "text",
  "company": "text",
  "job_title": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "username": "text",
  "email": "[email protected]",
  "is_active": true,
  "is_onboarded": true,
  "is_superuser": true
}

{
  "password": "text",
  "password_expired": true,
  "name": "text",
  "avatar_url": "text",
  "company": "text",
  "job_title": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "username": "text",
  "email": "text",
  "oauth_provider": "text",
  "oauth_id": "text",
  "is_active": true,
  "is_superuser": false,
  "is_service_account": false,
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_onboarded": false
}