Remove User From Workspace

DELETE 
https://cloud.agenta.ai/api/workspaces/:workspace_id/users

Remove a user from a workspace.

Parameters:

• payload (UserRole): The payload containing the user email and organization ID.
• workspace_id (str): The ID of the workspace.
• request (Request): The FastAPI request object.

Returns:

• WorkspaceResponse: The updated workspace.

Raises:

• HTTPException: If the user does not have permission to perform this action.
• HTTPException: If there is an error during the removal process.

Request

Path Parameters

workspace_id Workspace Idrequired

Query Parameters

org_id Org Idrequired
email Emailrequired

Responses

200

Successful Response

application/json

Schema

Schema

created_at Created At (string)

Default value: 2024-11-20 07:07:31.664723+00:00

updated_at Updated At (string)

Default value: 2024-11-20 07:07:31.664833+00:00

id Id (string)required
name Name (string)required

description

object

anyOf

MOD1

string

type

object

required

anyOf

MOD1

string

organization Organization (string)required

members

object

anyOf

MOD1

Array [

user objectrequired

roles

object[]

required

Array [

role_name WorkspaceRole (string)required

Possible values: [owner, viewer, editor, evaluator, workspace_admin, deployment_manager]

role_description

object

anyOf

MOD1

string

permissions

object

anyOf

MOD1

Array [

string

Possible values: [read_system, view_application, edit_application, create_application, delete_application, create_app_variant, delete_app_variant, modify_variant_configurations, delete_application_variant, view_app_environment_deployment, edit_app_environment_deployment, create_app_environment_deployment, view_testset, edit_testset, create_testset, delete_testset, view_evaluation, run_evaluations, edit_evaluation, create_evaluation, delete_evaluation, deploy_application, view_workspace, edit_workspace, create_workspace, delete_workspace, modify_user_roles, add_new_user_to_workspace, edit_organization, delete_organization, add_new_user_to_organization]

]

]

]

Example (from schema)

{
  "created_at": "2024-11-20 07:07:31.664723+00:00",
  "updated_at": "2024-11-20 07:07:31.664833+00:00",
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "organization": "string",
  "members": [
    null
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

Request Collapse all

Base URL

https://cloud.agenta.ai/api

Auth

APIKeyHeader

Parameters

workspace_id — pathrequired

org_id — queryrequired

email — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!