Overview
TheActiveUserResource provides methods for managing the currently authenticated user’s profile, projects, and settings. Access it via client.active_user after authenticating your SpeckleClient.
This resource represents your own user account and provides access to personal information, projects you have access to, and workspace memberships.
Methods
get()
Get your own user profile information.Your user profile, or
None if not authenticated. See Userupdate()
Update your user profile.Profile update parameters. See UserUpdateInput
The updated user profile. See User
name(str, optional) - New display namebio(str, optional) - New biographycompany(str, optional) - New company nameavatar(str, optional) - New avatar URL
Email and other sensitive fields cannot be updated via the API. Use the web interface to change
your email address.
get_projects()
Get all projects you have access to.When to use this method:
- Non-workspace servers (self-hosted/open-source): Use this method to list all projects you have access to.
- Workspace-enabled servers (e.g., app.speckle.systems): Use
client.workspace.get_projects(workspace_id)to list projects in a workspace.
stream resource with a list() method.Filter criteria. See UserProjectsFilter
get_projects_with_permissions()
Get your projects with detailed permission information.Filter criteria. See UserProjectsFilter
This method is useful when you need to check permissions before attempting operations, helping you
build more robust applications.
get_project_invites()
Get pending project invitations.Use the Speckle web interface to accept or decline invitations. This method only retrieves pending
invitations. See PendingStreamCollaborator for property details.
get_workspaces()
Get workspaces you’re a member of (workspace-enabled servers only).Filter criteria. See UserWorkspacesFilter
get_active_workspace()
Get your currently active workspace (workspace-enabled servers only).Types
User
Represents a Speckle user’s full profile (your own account).PendingStreamCollaborator
Represents a pending project invitation.User who sent the invitation. See
LimitedUser
Invited user (you). See
LimitedUser
Input Types
UserUpdateInput
update().
Fields:
avatar(str, optional) - Avatar image URLbio(str, optional) - User biographycompany(str, optional) - Company namename(str, optional) - Display name
Filters
UserProjectsFilter
get_projects() and get_projects_with_permissions().
Fields:
search(str, optional) - Search by project name or descriptiononly_with_roles(List[str], optional) - Filter by user rolesworkspace_id(str, optional) - Filter to specific workspaceinclude_implicit_access(bool, optional) - Include projects with implicit access
UserWorkspacesFilter
get_workspaces().
Fields:
search(str, optional) - Search by workspace name
Related Resources
OtherUserResource
Look up other users on the server
ProjectResource
Work with your projects
Authentication Guide
Learn about authentication methods
SpeckleClient
Main client documentation