Account (REST Client 0.25.15 API)

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

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

Account record for administrative accounts.

Constructor Summary

Constructors
Constructor and Description

Account()

Constructors
Constructor and Description
`Account()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Account`	`addDataGroupsItem(String dataGroupsItem)`
`Account`	`addLanguagesItem(String languagesItem)`
`Account`	`addRolesItem(Role rolesItem)`
`Account`	`attributes(Map<String,String> attributes)`
`Account`	`clientData(Object clientData)`
`Account`	`clientTimeZone(String clientTimeZone)`
`Account`	`dataGroups(List<String> dataGroups)`
`Account`	`email(String email)`
`Account`	`emailVerified(Boolean emailVerified)`
`boolean`	`equals(Object o)`
`Account`	`firstName(String firstName)`
`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.
`String`	`getClientTimeZone()` Participant's time zone.
`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.
`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.
`DateTime`	`getModifiedOn()` The date and time the account was last modified.
`String`	`getNote()` Optional note related to user account.
`String`	`getOrgMembership()` The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
`String`	`getPassword()` Account password.
`Phone`	`getPhone()` Get phone
`List<Role>`	`getRoles()` Get roles
`AccountStatus`	`getStatus()` Get status
`String`	`getSynapseUserId()` The numerical identifier for a Synapse account.
`String`	`getType()` Account
`Long`	`getVersion()` The optimistic locking version of the account.
`int`	`hashCode()`
`Boolean`	`isAdmin()` True if this is an administrative account (usually with roles and an association to an organization), or false if this is a study participant account.
`Boolean`	`isEmailVerified()` Has the user verified that they have control of this email address?
`Boolean`	`isPhoneVerified()` Has the user verified that they have control of this phone number?
`Account`	`languages(List<String> languages)`
`Account`	`lastName(String lastName)`
`Account`	`note(String note)`
`Account`	`orgMembership(String orgMembership)`
`Account`	`password(String password)`
`Account`	`phone(Phone phone)`
`Account`	`phoneVerified(Boolean phoneVerified)`
`Account`	`putAttributesItem(String key, String attributesItem)`
`Account`	`roles(List<Role> roles)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setClientData(Object clientData)`
`void`	`setClientTimeZone(String clientTimeZone)`
`void`	`setDataGroups(List<String> dataGroups)`
`void`	`setEmail(String email)`
`void`	`setEmailVerified(Boolean emailVerified)`
`void`	`setFirstName(String firstName)`
`void`	`setLanguages(List<String> languages)`
`void`	`setLastName(String lastName)`
`void`	`setNote(String note)`
`void`	`setOrgMembership(String orgMembership)`
`void`	`setPassword(String password)`
`void`	`setPhone(Phone phone)`
`void`	`setPhoneVerified(Boolean phoneVerified)`
`void`	`setRoles(List<Role> roles)`
`void`	`setStatus(AccountStatus status)`
`void`	`setSynapseUserId(String synapseUserId)`
`void`	`setVersion(Long version)`
`Account`	`status(AccountStatus status)`
`Account`	`synapseUserId(String synapseUserId)`
`String`	`toString()`
`Account`	`version(Long version)`

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

- Constructor Detail
  - Account
```
public Account()
```
- Method Detail
  - getId
```
public String getId()
```
    An ID assigned to this account by Bridge system.
    
    Returns:
    
    id
  - firstName
```
public Account firstName(String firstName)
```
  - getFirstName
```
public String getFirstName()
```
    First name (given name) of the user.
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
  - lastName
```
public Account lastName(String lastName)
```
  - getLastName
```
public String getLastName()
```
    Last name (family name) of the user.
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
  - synapseUserId
```
public Account synapseUserId(String synapseUserId)
```
  - 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
  - setSynapseUserId
```
public void setSynapseUserId(String synapseUserId)
```
  - email
```
public Account email(String email)
```
  - getEmail
```
public String getEmail()
```
    The user's email.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - phone
```
public Account phone(Phone phone)
```
  - getPhone
```
public Phone getPhone()
```
    Get phone
    
    Returns:
    
    phone
  - setPhone
```
public void setPhone(Phone phone)
```
  - password
```
public Account password(String password)
```
  - getPassword
```
public String getPassword()
```
    Account password.
    
    Returns:
    
    password
  - setPassword
```
public void setPassword(String password)
```
  - attributes
```
public Account attributes(Map<String,String> attributes)
```
  - putAttributesItem
```
public Account putAttributesItem(String key,
                                 String attributesItem)
```
  - 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
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the account was created.
    
    Returns:
    
    createdOn
  - getModifiedOn
```
public DateTime getModifiedOn()
```
    The date and time the account was last modified.
    
    Returns:
    
    modifiedOn
  - emailVerified
```
public Account emailVerified(Boolean emailVerified)
```
  - isEmailVerified
```
public Boolean isEmailVerified()
```
    Has the user verified that they have control of this email address?
    
    Returns:
    
    emailVerified
  - setEmailVerified
```
public void setEmailVerified(Boolean emailVerified)
```
  - phoneVerified
```
public Account phoneVerified(Boolean phoneVerified)
```
  - isPhoneVerified
```
public Boolean isPhoneVerified()
```
    Has the user verified that they have control of this phone number?
    
    Returns:
    
    phoneVerified
  - setPhoneVerified
```
public void setPhoneVerified(Boolean phoneVerified)
```
  - status
```
public Account status(AccountStatus status)
```
  - getStatus
```
public AccountStatus getStatus()
```
    Get status
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(AccountStatus status)
```
  - roles
```
public Account roles(List<Role> roles)
```
  - addRolesItem
```
public Account addRolesItem(Role rolesItem)
```
  - getRoles
```
public List<Role> getRoles()
```
    Get roles
    
    Returns:
    
    roles
  - setRoles
```
public void setRoles(List<Role> roles)
```
  - dataGroups
```
public Account dataGroups(List<String> dataGroups)
```
  - addDataGroupsItem
```
public Account addDataGroupsItem(String dataGroupsItem)
```
  - 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
  - setDataGroups
```
public void setDataGroups(List<String> dataGroups)
```
  - clientData
```
public Account clientData(Object clientData)
```
  - 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
  - setClientData
```
public void setClientData(Object clientData)
```
  - languages
```
public Account languages(List<String> languages)
```
  - addLanguagesItem
```
public Account addLanguagesItem(String languagesItem)
```
  - 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
  - setLanguages
```
public void setLanguages(List<String> languages)
```
  - orgMembership
```
public Account orgMembership(String orgMembership)
```
  - 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). Once set, it cannot be changed on an update (there are separate organization membership APIs to change organizational membership).
    
    Returns:
    
    orgMembership
  - setOrgMembership
```
public void setOrgMembership(String orgMembership)
```
  - note
```
public Account note(String note)
```
  - getNote
```
public String getNote()
```
    Optional note related to user account. Can only be edited and viewed by an administrative account.
    
    Returns:
    
    note
  - setNote
```
public void setNote(String note)
```
  - clientTimeZone
```
public Account clientTimeZone(String clientTimeZone)
```
  - getClientTimeZone
```
public String getClientTimeZone()
```
    Participant's time zone. Can be updated or deleted. Must be an IANA time zone name.
    
    Returns:
    
    clientTimeZone
  - setClientTimeZone
```
public void setClientTimeZone(String clientTimeZone)
```
  - isAdmin
```
public Boolean isAdmin()
```
    True if this is an administrative account (usually with roles and an association to an organization), or false if this is a study participant account. An account is an admin account if it is created through the administrative account APIs.
    
    Returns:
    
    admin
  - version
```
public Account version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    The optimistic locking version of the account. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring. It can also serve as a key to determine if a local cache of this `Account` needs to be updated.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - getType
```
public String getType()
```
    Account
    
    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 Account

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Account

Method Detail

getId

firstName

getFirstName

setFirstName

lastName

getLastName

setLastName

synapseUserId

getSynapseUserId

setSynapseUserId

email

getEmail

setEmail

phone

getPhone

setPhone

password

getPassword

setPassword

attributes

putAttributesItem

getAttributes

setAttributes

getCreatedOn

getModifiedOn

emailVerified

isEmailVerified

setEmailVerified

phoneVerified

isPhoneVerified

setPhoneVerified

status

getStatus

setStatus

roles

addRolesItem

getRoles

setRoles

dataGroups

addDataGroupsItem

getDataGroups

setDataGroups

clientData

getClientData

setClientData

languages

addLanguagesItem

getLanguages

setLanguages

orgMembership

getOrgMembership

setOrgMembership

note

getNote

setNote

clientTimeZone

getClientTimeZone

setClientTimeZone

isAdmin

version

getVersion

setVersion

getType

equals

hashCode

toString