OpenCGA
OverviewInstallationUsing OpenCGA
v2.2
v2.2
  • Home
  • Overview
    • Features
    • Architecture Diagram
    • Security
    • Metadata and Clinical Data
    • Data Models
      • Sample
      • Individual
    • Alignment and Coverage
    • Variant Query and Analysis
    • Clinical Data Analysis
    • Running Analysis
    • Scalability and Performance
    • Sizing OpenCGA
  • OpenCGA Architecture
    • Catalog
    • Alignment and Coverage
    • Variant Storage Engine
      • Variant Data Model
    • Clinical Analysis
    • Analysis Framework
  • Data Models
    • User
    • Project
    • Study
    • File
    • Sample
    • Individual
    • Family
    • Cohort
    • Job
    • Clinical Analysis
  • Case Studies
    • Genomics England Research
    • Microsoft Azure
  • User Manual
    • Installation
      • Kubernetes Cluster
        • Azure
        • Configuration
      • On-Premise HPC Cluster
        • Server Configuration
        • Getting OpenCGA
        • Choosing Variant Storage Engine
        • Configuration
      • Running Docker
    • Login
    • Using OpenCGA
      • REST Web Service API
      • IVA Web App
      • Client Libraries
        • pyopencga - Python Library
        • opencgaR - R library
        • Java
        • JavaScript
      • Command Line
        • Configuration
        • Files
      • Public Demo
    • Managing Data
      • Working with Projects and Studies
      • Loading of VCF files
      • Create Projects and Studies
      • Load VCF Files to a Study
      • Working with Files
      • Sharing and Permissions
        • Users and Groups
        • Study ACLs
      • Population of metadata
        • Data Versioning
        • Adding Custom Metadata
    • Alignment Engine
      • BAM Index
      • Alignment Read Query
      • Working with Coverage
      • Alignment Analysis
    • Variant Storage Engine
      • Variant Query
      • Variant Aggregation Stats
      • Variant Analysis
    • Clinical Genomics
      • Clinical Interpretation
      • Clinical Analysis
    • Using JupyterLab
    • Administrator
      • User Management
      • Templates / Manifest
  • About
    • Roadmap
    • Release Notes
    • Community
Powered by GitBook
On this page
  • Overview
  • Summary
  • Data Model
  • User
  • UserFilter
  • UserQuota
  • UserInternal
  • Account
  • AuthenticationOrigin

Was this helpful?

  1. Data Models

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

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.

User account.

Internal field for manage the object.

User quota

A List with related projects.

A List with shared projects.

configs Map<String,Map

User configurations

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

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

UserInternal

Account

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.

How the account is authenticated

AuthenticationOrigin

PreviousData ModelsNextProject

Last updated 2 years ago

Was this helpful?

You can find the Java code .

account

internal

quota

projects List<>

sharedProjects List<>

filters List<>

You can find the Java code .

You can find the Java code .

You can find the Java code .

You can find the Java code .

authentication

You can find the Java code .

here
here
here
here
here
here
Account
UserInternal
UserQuota
Project
Project
UserFilter
AuthenticationOrigin