UserSessionInfo (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.UserSessionInfo

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class UserSessionInfo
extends Object

UserSessionInfo

Constructor Summary

Constructors
Constructor and Description

UserSessionInfo()

Constructors
Constructor and Description
`UserSessionInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAttributes()` A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
`Object`	`getClientData()` Client data for a user should be in a syntactically valid JSON format.
`Map<String,ConsentStatus>`	`getConsentStatuses()` A mapping from a subpopulation GUID to information about the participant's consent status in that subpopulation (whether consented or not).
`DateTime`	`getCreatedOn()` The date and time the account was created.
`List<String>`	`getDataGroups()` The data groups set for this user.
`String`	`getEmail()` The user's email.
`Map<String,EnrollmentInfo>`	`getEnrollments()` Records of every enrollment (whether withdrawn or not) in every study for this participant.
`Environment`	`getEnvironment()` Get environment
`String`	`getExternalId()` An externally-assignable identifier a research partner can use to re-identify a user's data in the exported data set (this must be provided by the application, it is not created by Bridge).
`Map<String,String>`	`getExternalIds()` The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
`String`	`getFirstName()` First name (given name) of the user.
`String`	`getId()` An ID assigned to this account by Bridge system.
`List<String>`	`getLanguages()` Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
`String`	`getLastName()` Last name (family name) of the user.
`String`	`getOrgMembership()` The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
`Phone`	`getPhone()` Get phone
`String`	`getReauthToken()` A token, supplied when a new session is returned, that can be used to refresh the session at a later time.
`List<Role>`	`getRoles()` Get roles
`String`	`getSessionToken()` The session token that must be returned to the server to access services requiring authentication.
`SharingScope`	`getSharingScope()` Get sharingScope
`AccountStatus`	`getStatus()` Get status
`List<String>`	`getStudyIds()` The studies this participant is associated to.
`String`	`getSynapseUserId()` The numerical identifier for a Synapse account.
`String`	`getType()` UserSessionInfo
`int`	`hashCode()`
`Boolean`	`isAuthenticated()` Is the user currently authenticated?
`Boolean`	`isConsented()` True if all required consents have been signed.
`Boolean`	`isDataSharing()` True if the sharing scope is anything other than \"no_sharing\".
`Boolean`	`isEmailVerified()` Has the user verified that they have control of this email address?
`Boolean`	`isNotifyByEmail()` True if the user has consented to be contacted via email outside the application, false otherwise.
`Boolean`	`isPhoneVerified()` Has the user verified that they have control of this phone number?
`Boolean`	`isSignedMostRecentConsent()` True if all required consents have been signed and the versions signed are the most up-to-date versions of those consents.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserSessionInfo
```
public UserSessionInfo()
```
- Method Detail
  - getFirstName
```
public String getFirstName()
```
    First name (given name) of the user.
    
    Returns:
    
    firstName
  - getLastName
```
public String getLastName()
```
    Last name (family name) of the user.
    
    Returns:
    
    lastName
  - getExternalId
```
public String getExternalId()
```
    An externally-assignable identifier a research partner can use to re-identify a user's data in the exported data set (this must be provided by the application, it is not created by Bridge). It is a string that can be set or updated to any value without constraints, unless Bridge is configured to manage the study's external IDs. Then the ID must be submitted on sign up, and cannot be modified afterward.
    
    Returns:
    
    externalId
  - getId
```
public String getId()
```
    An ID assigned to this account by Bridge system. This ID is exposed in the API and is different from the health code assigned to the user's anonymized data. Bridge never exports this ID along with the health code from Bridge.
    
    Returns:
    
    id
  - isNotifyByEmail
```
public Boolean isNotifyByEmail()
```
    True if the user has consented to be contacted via email outside the application, false otherwise.
    
    Returns:
    
    notifyByEmail
  - getAttributes
```
public Map<String,String> getAttributes()
```
    A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
    
    Returns:
    
    attributes
  - getSharingScope
```
public SharingScope getSharingScope()
```
    Get sharingScope
    
    Returns:
    
    sharingScope
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the account was created.
    
    Returns:
    
    createdOn
  - isEmailVerified
```
public Boolean isEmailVerified()
```
    Has the user verified that they have control of this email address?
    
    Returns:
    
    emailVerified
  - isPhoneVerified
```
public Boolean isPhoneVerified()
```
    Has the user verified that they have control of this phone number?
    
    Returns:
    
    phoneVerified
  - getStatus
```
public AccountStatus getStatus()
```
    Get status
    
    Returns:
    
    status
  - getRoles
```
public List<Role> getRoles()
```
    Get roles
    
    Returns:
    
    roles
  - getDataGroups
```
public List<String> getDataGroups()
```
    The data groups set for this user. Data groups must be strings that are defined in the list of all valid data groups for the app, as part of the app object.
    
    Returns:
    
    dataGroups
  - getClientData
```
public Object getClientData()
```
    Client data for a user should be in a syntactically valid JSON format. It will be returned as is to the client (as JSON).
    
    Returns:
    
    clientData
  - getLanguages
```
public List<String> getLanguages()
```
    Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
    
    Returns:
    
    languages
  - getStudyIds
```
public List<String> getStudyIds()
```
    The studies this participant is associated to.
    
    Returns:
    
    studyIds
  - getExternalIds
```
public Map<String,String> getExternalIds()
```
    The exernal IDs this participant is associated to, mapped to the study that issued the external ID. Typically a user signs up with the external ID, and is assigned to that study as a result.
    
    Returns:
    
    externalIds
  - isAuthenticated
```
public Boolean isAuthenticated()
```
    Is the user currently authenticated?
    
    Returns:
    
    authenticated
  - getSessionToken
```
public String getSessionToken()
```
    The session token that must be returned to the server to access services requiring authentication.
    
    Returns:
    
    sessionToken
  - getReauthToken
```
public String getReauthToken()
```
    A token, supplied when a new session is returned, that can be used to refresh the session at a later time. The API to reauthenticate with the token will refresh your session token and reset the session's timeout value. The reauthentication token can only be used one time.
    
    Returns:
    
    reauthToken
  - getEnvironment
```
public Environment getEnvironment()
```
    Get environment
    
    Returns:
    
    environment
  - getEmail
```
public String getEmail()
```
    The user's email.
    
    Returns:
    
    email
  - getPhone
```
public Phone getPhone()
```
    Get phone
    
    Returns:
    
    phone
  - isDataSharing
```
public Boolean isDataSharing()
```
    True if the sharing scope is anything other than \"no_sharing\".
    
    Returns:
    
    dataSharing
  - isSignedMostRecentConsent
```
public Boolean isSignedMostRecentConsent()
```
    True if all *required* consents have been signed and the versions signed are the most up-to-date versions of those consents.
    
    Returns:
    
    signedMostRecentConsent
  - getSynapseUserId
```
public String getSynapseUserId()
```
    The numerical identifier for a Synapse account. For administrative accounts, this will allow the user to sign in using Synapse accounts, no further credentials are needed to access the system. This value can only be set when creating an account; otherwise the identifiers update API must be used to add the ID to an existing account.
    
    Returns:
    
    synapseUserId
  - isConsented
```
public Boolean isConsented()
```
    True if all required consents have been signed.
    
    Returns:
    
    consented
  - getConsentStatuses
```
public Map<String,ConsentStatus> getConsentStatuses()
```
    A mapping from a subpopulation GUID to information about the participant's consent status in that subpopulation (whether consented or not). Only the subpopulations that currently apply to this user will have a ConsentStatus object in the map.
    
    Returns:
    
    consentStatuses
  - getEnrollments
```
public Map<String,EnrollmentInfo> getEnrollments()
```
    Records of every enrollment (whether withdrawn or not) in every study for this participant. The key of this mapping is the studyId, and the value is the record of the enrollment.
    
    Returns:
    
    enrollments
  - getOrgMembership
```
public String getOrgMembership()
```
    The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
    
    Returns:
    
    orgMembership
  - getType
```
public String getType()
```
    UserSessionInfo
    
    Returns:
    
    type
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UserSessionInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSessionInfo

Method Detail

getFirstName

getLastName

getExternalId

getId

isNotifyByEmail

getAttributes

getSharingScope

getCreatedOn

isEmailVerified

isPhoneVerified

getStatus

getRoles

getDataGroups

getClientData

getLanguages

getStudyIds

getExternalIds

isAuthenticated

getSessionToken

getReauthToken

getEnvironment

getEmail

getPhone

isDataSharing

isSignedMostRecentConsent

getSynapseUserId

isConsented

getConsentStatuses

getEnrollments

getOrgMembership

getType

equals

hashCode

toString