rhino_health.lib.endpoints.user.user_dataclass#

Module Contents#

Classes#

User

DataClass representing a User on the Rhino platform.

class rhino_health.lib.endpoints.user.user_dataclass.User(**data)#

Bases: User

DataClass representing a User on the Rhino platform.

uid :str#

Unique ID of the user

full_name :str#

The full name of the user

primary_workgroup_uid :str#

The Unique ID of the Primary Workgroup of the user

workgroups_uids :List[str]#

Additional workgroup unique IDs the user belongs to

primary_workgroup(self)#

Get the primary workgroup of this user

Warning

Be careful when calling this for newly created objects. The workgroup associated with the PRIMARY_WORKGROUP_UID must already exist on the platform.

Warning

The result of this function is cached. Be careful calling this function after making changes to the primary workgroup

Returns
primary_workgroup: Workgroup

A DataClass representing the Workgroup of the user’s primary workgroup

workgroups(self)#

Get the non primary workgroups of this user

Warning

Be careful when calling this for newly created objects. The workgroups associated with the WORKGROUP_UIDS must already exist on the platform.

Warning

The result of this function is cached. Be careful calling this function after making changes to the workgroups

Returns
workgroups: List[Workgroup]

An array of DataClasses representing the additional workgroups the user is a member of