sampledbapi.users module

class sampledbapi.users.User(d: Dict)[source]

Bases: SampleDBObject

affiliation: str | None = None

email: str | None = None

name: str | None = None

orcid: str | None = None

role: str | None = None

user_id: int | None = None

sampledbapi.users.get(user_id: int) → User[source]

Get the specific user (user_id).

Parameters:: user_id (int) – ID of the user to be retrieved.
Returns:: Requested User.
Return type:: User

sampledbapi.users.get_current() → User[source]

Get the current user.

Returns:: Current User.
Return type:: User

sampledbapi.users.get_list() → List[User][source]

Get a list of all users.

Returns:: List of User objects.
Return type:: List