Skip to main content

Remove User From Workspace

DELETE 
/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​

Successful Response

Schema

    created_at date-time

    Default value: 2024-05-15T13:56:52.061787

    updated_at date-time

    Default value: 2024-05-15T13:56:52.061801

    id Id (string)required
    name Name (string)required
    description Description (string)
    type Type (string)
    organization Organization (string)required

    members

    object[]

  • Array [

    • user objectrequired

    roles

    object[]

    required

  • Array [

    • role_name WorkspaceRole (string)required

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

    An enumeration.

    role_description Role Description (string)
    permissions Permission (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]

  • ]

  • ]

Loading...