Users
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 organization_manager: Organization manager rbac: RBAC component
Returns: List of users matching the filter criteria
0100Successful Response
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.
The name of the user.
The avatar URL of the user.
The company of the user.
The job title of the user.
The unique username for the account. For OAuth2 user accounts, this is the same as the email address.
^[a-zA-Z0-9_\-@.]+$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.
The external OAuth2 provider that the user is associated with.
The external OAuth2 ID of the user.
Whether the account is active.
trueWhether the account is a superuser.
falseWhether the account is a service account.
falseThe ID of the organization that the service account belongs to. Only set for service accounts.
The time when the user's password was last changed.
Whether the user has completed onboarding.
falseValidation Error
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",
"password_changed_at": "2026-01-01T00:00:00.000Z",
"is_onboarded": false
}
]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.
Successful Response
Validation Error
DELETE /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
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.
Model for user updates.
The name of the user.
The avatar URL of the user.
The company of the user.
The job title of the user.
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.
^[a-zA-Z0-9_\-@.]+$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.
Successful Response
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.
The name of the user.
The avatar URL of the user.
The company of the user.
The job title of the user.
The unique username for the account. For OAuth2 user accounts, this is the same as the email address.
^[a-zA-Z0-9_\-@.]+$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.
The external OAuth2 provider that the user is associated with.
The external OAuth2 ID of the user.
Whether the account is active.
trueWhether the account is a superuser.
falseWhether the account is a service account.
falseThe ID of the organization that the service account belongs to. Only set for service accounts.
The time when the user's password was last changed.
Whether the user has completed onboarding.
falseValidation Error
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": "name@gmail.com",
"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",
"password_changed_at": "2026-01-01T00:00:00.000Z",
"is_onboarded": false
}
Last updated
Was this helpful?