# User
## Overview
Created by imedina on 11/09/14.
### Summary
| Field | create | update | unique | required |
| -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| id |  |  |  |  |
| name |  |  |  |  |
| email |  |  |  |  |
| organization |  |  |  |  |
| account |  |  |  |  |
| quota |  |  |  |  |
| projects |  |  |  |  |
| sharedProjects |  |  |  |  |
| configs |  |  |  |  |
| filters |  |  |  |  |
| attributes |  |  |  |  |
| internal |  |  |  |  |
## Data Model
### User
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/user/User.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| id
String
| User ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.*Tags*: *required, immutable, unique* |
| name
String
| |
| email
String
| |
| organization
String
| |
| account
Account
| |
| internal
UserInternal
| An object describing the internal information of the User. This is managed by OpenCGA.*Tags*: *internal* |
| quota
UserQuota
| |
| projects
List<Project>
| A List with related projects. |
| sharedProjects
List<Project>
| |
| configs
Map<ObjectMap,String>
| |
| filters
List<UserFilter>
| |
| attributes
Map<Object,String>
| You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes. |
### UserQuota
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/user/UserQuota.java).
| Field | Description |
| -------------------------------------------------------- | ------------------------------------------------------------ |
| diskUsage
long
| Current disk usage of user in bytes. |
| cpuUsage
int
| Current cpu usage in seconds. |
| maxDisk
long
| Maximum amount of disk in bytes allowed for the user to use. |
| maxCpu
int
| Maximum amount of seconds the user can use of CPU. |
### Project
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/project/Project.java).
| Field | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id
String
| Project ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.*Tags*: *required, immutable, unique* |
| uuid
String
| Global unique ID at the whole OpenCGA installation. This is automatically created during the Project creation and cannot be changed.*Tags*: *internal, unique, immutable* |
| name
String
| |
| fqn
String
| Full Qualified Name (user\@projectId). |
| creationDate
String
| String representing when the sample was created, this is automatically set by OpenCGA.*Tags*: *internal* |
| modificationDate
String
| String representing when was the last time the sample was modified, this is automatically set by OpenCGA.*Tags*: *internal* |
| description
String
| An string to describe the properties of the sample. |
| organism
ProjectOrganism
| |
| currentRelease
int
| |
| studies
List<Study>
| |
| internal
ProjectInternal
| An object describing the internal information of the Project. This is managed by OpenCGA.*Tags*: *internal* |
| attributes
Map<Object,String>
| You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes. |
### Enum Account
*Enumeration class.* You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/user/Account.java).
| Field | Description |
| ------------------------------------------- | ----------- |
| type
| |
| creationDate
| |
| expirationDate
| |
| authentication
| |
### UserFilter
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/user/UserFilter.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| id
String
| |
| description
String
| |
| resource
Resource
| |
| query
Query
| |
| options
QueryOptions
| |
### SampleInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/sample/SampleInternal.java).
| Field | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
Status
| |
| rga
RgaIndex
| |
### IndividualInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/individual/IndividualInternal.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
Status
| |
### FamilyInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/family/FamilyInternal.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
FamilyStatus
| |
### FileInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/file/FileInternal.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
FileStatus
| |
| index
FileIndex
| |
| sampleMap
Map<String>
| |
| missingSamples
MissingSamples
| |
### JobInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/job/JobInternal.java).
| Field | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
ExecutionStatus
| |
| webhook
JobInternalWebhook
| |
| events
List<Event>
| |
### InterpretationInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/clinical/InterpretationInternal.java).
| Field | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
InterpretationStatus
| |
### ProjectInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/project/ProjectInternal.java).
| Field | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| datastores
Datastores
| |
| cellbase
CellBaseConfiguration
| |
| status
Status
| |
### CohortInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/cohort/CohortInternal.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
CohortStatus
| |
### ClinicalAnalysisInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/clinical/ClinicalAnalysisInternal.java).
| Field | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
ClinicalAnalysisStatus
| |
### UserInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/user/UserInternal.java).
| Field | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
UserStatus
| |
### StudyInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyInternal.java).
| Field | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
Status
| |
| configuration
StudyConfiguration
| |