User

Overview

User data model hosts information about any user.

Summary

Field	Create	Update	Unique	Required
id
name
email
organization
account
internal
quota
projects
sharedProjects
configs
filters
attributes

Data Model

User

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
name String	User name.
email String	User email.
organization String	User organization.
account Account	User account.
internal UserInternal	Internal field for manage the object.
quota UserQuota	User quota
projects List<Project>	A List with related projects.
sharedProjects List<Project>	A List with shared projects.
configs Map<String,Map	User configurations
filters List<UserFilter>	A List with related filters.
attributes Map<String,Object>	You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes.

UserFilter

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
description String	Users may provide a description for the entry.
resource Resource	User resource can have the values AUDIT, USER, PROJECT, STUDY, FILE, SAMPLE, JOB, INDIVIDUAL, COHORT, DISEASE_PANEL, FAMILY, CLINICAL_ANALYSIS, INTERPRETATION, VARIANT, ALIGNMENT, CLINICAL, EXPRESSION, RGA and FUNCTIONAL.
query Query	User filter query
query QueryOptions	User filter query options

UserQuota

You can find the Java code here.

UserInternal

You can find the Java code here.

Account

You can find the Java code here.

Field	Description
type AccountType	User account type can have the values GUEST, FULL and ADMINISTRATOR.
creationDate String	Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was first registered.
expirationDate String	Date the account expires.
authentication AuthenticationOrigin	How the account is authenticated

AuthenticationOrigin

You can find the Java code here.