Skip to main content

client.workspaces()

MethodRouteInputsBuilder optionssend() returns
fetch_workspaces()GET /workspacesnonelimit(i32), offset(i32), search(String), sort_key(String), sort_order(String)PaginatedResponse<Workspace>
fetch_workspace(workspace_id)GET /workspaces/{workspace_id}workspace_id: &strnoneWorkspace
update_workspace(workspace_id, request)PATCH /workspaces/{workspace_id}workspace_id: &str, UpdateWorkspaceRequestnoneWorkspace
delete_workspace(workspace_id)DELETE /workspaces/{workspace_id}workspace_id: &strnone()
members()accessornonenoneWorkspaceMembersApi
roles()accessornonenoneWorkspaceRolesApi

client.workspaces().members()

MethodRouteInputsBuilder optionssend() returns
fetch_members(workspace_id)GET /workspaces/{workspace_id}/membersworkspace_id: &strlimit(i32), offset(i32), search(String), sort_key(String), sort_order(String)PaginatedResponse<WorkspaceMember>
add_member(workspace_id, user_id, role_ids)POST /workspaces/{workspace_id}/membersworkspace_id: &str, user_id: &str, role_ids: Vec<String>noneWorkspaceMember
update_member(workspace_id, membership_id)PATCH /workspaces/{workspace_id}/members/{membership_id}workspace_id: &str, membership_id: &strrole_ids(Vec<String>), public_metadata(serde_json::Value)()
remove_member(workspace_id, membership_id)DELETE /workspaces/{workspace_id}/members/{membership_id}workspace_id: &str, membership_id: &strnone()

client.workspaces().roles()

MethodRouteInputsBuilder optionssend() returns
fetch_roles(workspace_id)GET /workspaces/{workspace_id}/rolesworkspace_id: &strnonePaginatedResponse<WorkspaceRole>
create_role(workspace_id, request)POST /workspaces/{workspace_id}/rolesworkspace_id: &str, CreateRoleRequestnoneWorkspaceRole
update_role(workspace_id, role_id, request)PATCH /workspaces/{workspace_id}/roles/{role_id}workspace_id: &str, role_id: &str, UpdateRoleRequestnoneWorkspaceRole
delete_role(workspace_id, role_id)DELETE /workspaces/{workspace_id}/roles/{role_id}workspace_id: &str, role_id: &strnone()

Contract Notes

  • Workspace roles and members are workspace-path scoped. No deployment-level role route is used by the Rust SDK.
  • update_workspace uses multipart request encoding.