user

Classes:

Bookmark	Bookmarked file path
Email	Email address information associated with a user account
FileBrowserState	State of the user's file browser
LoginService	Service information for login/resume functionality
LoginToken	Login token for resuming sessions
PasswordService	Service information for password-based authentication
Profile	Profile information for a user account
RecentJob	Recently accessed job
RecentPath	Recently accessed file path
RecentSession	Recently accessed session
RecentWorkspace	Recently accessed workspace
Services	Authentication services associated with a user account
User	User account information
UserState	State information for a user account

class Bookmark

Bookmarked file path

Attributes:

color
created_at
description
id
last_accessed
name
path

color: str

created_at: datetime

description: str

id: str

last_accessed: datetime

name: str

path: str

class Email

Email address information associated with a user account

Attributes:

address
verified

address: str

verified: bool

class FileBrowserState

State of the user’s file browser

Attributes:

bookmarks
recentPaths

bookmarks: List[Bookmark]

recentPaths: List[RecentPath]

class LoginService

Service information for login/resume functionality

Attributes:

loginTokens

loginTokens: List[LoginToken]

class LoginToken

Login token for resuming sessions

Attributes:

hashedToken
when

hashedToken: str

when: datetime

class PasswordService

Service information for password-based authentication

Attributes:

bcrypt

The bcrypt-hashed password value

bcrypt: str

The bcrypt-hashed password value

class Profile

Profile information for a user account

Attributes:

name

name: str | Dict[str, Any]

class RecentJob

Recently accessed job

Attributes:

job_uid
project_uid
workspace_uid

job_uid: str

project_uid: str

workspace_uid: str

class RecentPath

Recently accessed file path

Attributes:

last_accessed
path

last_accessed: datetime

path: str

class RecentSession

Recently accessed session

Attributes:

project_uid
session_uid

project_uid: str

session_uid: str

class RecentWorkspace

Recently accessed workspace

Attributes:

project_uid
workspace_uid

project_uid: str

workspace_uid: str

class Services

Authentication services associated with a user account

Attributes:

password	Service information for password-based authentication
resume	Service information for resuming sessions

password: PasswordService | None

Service information for password-based authentication

resume: LoginService

Service information for resuming sessions

class User

User account information

Attributes:

created_at	When this object was first created.
created_by_user_id	ID of the admin user who created this account, if applicable
emails
file_browser_settings
first_name	First/given name
id
lanes	List of scheduler lane names that a user is allowed to queue to.
last_name	Last/family name
last_password_changed_at
name	Username
preferences
profile
register_token
reset_token
roles
services
state
status	Registration status
updated_at	When this object was last modified.

created_at: datetime

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

created_by_user_id: str | None

ID of the admin user who created this account, if applicable

emails: List[Email]

file_browser_settings: FileBrowserPrefixes

first_name: str

First/given name

id: str

lanes: List[str]

List of scheduler lane names that a user is allowed to queue to. Admins may queue to all lanes, regardless of this value.

last_name: str

Last/family name

last_password_changed_at: datetime | None

name: str

Username

preferences: Dict[str, Any]

profile: Profile

register_token: str | None

reset_token: str | None

roles: Dict[str, List[Literal['user', 'admin']]]

services: Services

state: UserState

status: Literal['invited']

Registration status

updated_at: datetime

When this object was last modified.

class UserState

State information for a user account

Attributes:

browserPath
defaultJobPriority
licenseAccepted
recentJobs
recentProjects
recentSessions
recentWorkspaces
userCanSetJobPriority
userFileBrowserState

browserPath: str | None

defaultJobPriority: int | None

licenseAccepted: bool

recentJobs: List[RecentJob]

recentProjects: List[str]

recentSessions: List[RecentSession]

recentWorkspaces: List[RecentWorkspace]

userCanSetJobPriority: bool

userFileBrowserState: FileBrowserState