SignUp (REST Client 0.25.15 API)

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

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class SignUp
extends Object
```
The information necessary to sign up for a Bridge app. **Only the app's ID, an email address, and a password are required to sign up for an app.** However, all the information of [AbstractStudyParticipant](#AbstractStudyParticipant) can be submitted at sign up. In some configurations of the server, for example, an `externalId` value must be submitted at the time of sign up.

Constructor Summary

Constructors
Constructor and Description

SignUp()

Constructors
Constructor and Description
`SignUp()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SignUp`	`addDataGroupsItem(String dataGroupsItem)`
`SignUp`	`addLanguagesItem(String languagesItem)`
`SignUp`	`addRolesItem(Role rolesItem)`
`SignUp`	`appId(String appId)`
`SignUp`	`attributes(Map<String,String> attributes)`
`SignUp`	`clientData(Object clientData)`
`SignUp`	`clientTimeZone(String clientTimeZone)`
`SignUp`	`consent(Boolean consent)`
`SignUp`	`dataGroups(List<String> dataGroups)`
`SignUp`	`email(String email)`
`SignUp`	`emailVerified(Boolean emailVerified)`
`boolean`	`equals(Object o)`
`SignUp`	`externalId(String externalId)`
`SignUp`	`externalIds(Map<String,String> externalIds)`
`SignUp`	`firstName(String firstName)`
`String`	`getAppId()` The app ID of the app the participant is joining.
`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`	`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`	`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()` User's password.
`Phone`	`getPhone()` Get phone
`List<Role>`	`getRoles()` Get roles
`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()` SignUp
`int`	`hashCode()`
`Boolean`	`isConsent()` Create user API for admins only. Create this user consented to all required consents.
`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?
`SignUp`	`languages(List<String> languages)`
`SignUp`	`lastName(String lastName)`
`SignUp`	`note(String note)`
`SignUp`	`notifyByEmail(Boolean notifyByEmail)`
`SignUp`	`orgMembership(String orgMembership)`
`SignUp`	`password(String password)`
`SignUp`	`phone(Phone phone)`
`SignUp`	`phoneVerified(Boolean phoneVerified)`
`SignUp`	`putAttributesItem(String key, String attributesItem)`
`SignUp`	`putExternalIdsItem(String key, String externalIdsItem)`
`SignUp`	`roles(List<Role> roles)`
`void`	`setAppId(String appId)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setClientData(Object clientData)`
`void`	`setClientTimeZone(String clientTimeZone)`
`void`	`setConsent(Boolean consent)`
`void`	`setDataGroups(List<String> dataGroups)`
`void`	`setEmail(String email)`
`void`	`setEmailVerified(Boolean emailVerified)`
`void`	`setExternalId(String externalId)`
`void`	`setExternalIds(Map<String,String> externalIds)`
`void`	`setFirstName(String firstName)`
`void`	`setLanguages(List<String> languages)`
`void`	`setLastName(String lastName)`
`void`	`setNote(String note)`
`void`	`setNotifyByEmail(Boolean notifyByEmail)`
`void`	`setOrgMembership(String orgMembership)`
`void`	`setPassword(String password)`
`void`	`setPhone(Phone phone)`
`void`	`setPhoneVerified(Boolean phoneVerified)`
`void`	`setRoles(List<Role> roles)`
`void`	`setSharingScope(SharingScope sharingScope)`
`void`	`setStatus(AccountStatus status)`
`void`	`setSynapseUserId(String synapseUserId)`
`SignUp`	`sharingScope(SharingScope sharingScope)`
`SignUp`	`status(AccountStatus status)`
`SignUp`	`synapseUserId(String synapseUserId)`
`String`	`toString()`

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

- Constructor Detail
  - SignUp
```
public SignUp()
```
- Method Detail
  - firstName
```
public SignUp firstName(String firstName)
```
  - getFirstName
```
public String getFirstName()
```
    First name (given name) of the user.
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
  - lastName
```
public SignUp lastName(String lastName)
```
  - getLastName
```
public String getLastName()
```
    Last name (family name) of the user.
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
  - synapseUserId
```
public SignUp 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)
```
  - 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
  - notifyByEmail
```
public SignUp notifyByEmail(Boolean notifyByEmail)
```
  - isNotifyByEmail
```
public Boolean isNotifyByEmail()
```
    True if the user has consented to be contacted via email outside the application, false otherwise.
    
    Returns:
    
    notifyByEmail
  - setNotifyByEmail
```
public void setNotifyByEmail(Boolean notifyByEmail)
```
  - attributes
```
public SignUp attributes(Map<String,String> attributes)
```
  - putAttributesItem
```
public SignUp 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)
```
  - sharingScope
```
public SignUp sharingScope(SharingScope sharingScope)
```
  - getSharingScope
```
public SharingScope getSharingScope()
```
    Get sharingScope
    
    Returns:
    
    sharingScope
  - setSharingScope
```
public void setSharingScope(SharingScope sharingScope)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the account was created.
    
    Returns:
    
    createdOn
  - emailVerified
```
public SignUp 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 SignUp 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 SignUp status(AccountStatus status)
```
  - getStatus
```
public AccountStatus getStatus()
```
    Get status
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(AccountStatus status)
```
  - roles
```
public SignUp roles(List<Role> roles)
```
  - addRolesItem
```
public SignUp addRolesItem(Role rolesItem)
```
  - getRoles
```
public List<Role> getRoles()
```
    Get roles
    
    Returns:
    
    roles
  - setRoles
```
public void setRoles(List<Role> roles)
```
  - dataGroups
```
public SignUp dataGroups(List<String> dataGroups)
```
  - addDataGroupsItem
```
public SignUp 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 SignUp 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 SignUp languages(List<String> languages)
```
  - addLanguagesItem
```
public SignUp 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)
```
  - getStudyIds
```
public List<String> getStudyIds()
```
    The studies this participant is associated to. For administrative accounts, these are the studies associated to the account's organization. For study participants, these will be the studies that the person is enrolled in.
    
    Returns:
    
    studyIds
  - externalIds
```
public SignUp externalIds(Map<String,String> externalIds)
```
  - putExternalIdsItem
```
public SignUp putExternalIdsItem(String key,
                                 String externalIdsItem)
```
  - 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
  - setExternalIds
```
public void setExternalIds(Map<String,String> externalIds)
```
  - orgMembership
```
public SignUp 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 SignUp 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 SignUp 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)
```
  - appId
```
public SignUp appId(String appId)
```
  - getAppId
```
public String getAppId()
```
    The app ID of the app the participant is joining.
    
    Returns:
    
    appId
  - setAppId
```
public void setAppId(String appId)
```
  - email
```
public SignUp email(String email)
```
  - getEmail
```
public String getEmail()
```
    The user's email. Users can use the same email for different studies, but their account is identified by the email within an app.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - phone
```
public SignUp phone(Phone phone)
```
  - getPhone
```
public Phone getPhone()
```
    Get phone
    
    Returns:
    
    phone
  - setPhone
```
public void setPhone(Phone phone)
```
  - externalId
```
public SignUp externalId(String externalId)
```
  - 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). The value can be set on creation or added on an account update, but it will be returned in the `externalIds` mapping which specifies the study within which the external ID was defined. This field will be null when retrieved from the server.
    
    Returns:
    
    externalId
  - setExternalId
```
public void setExternalId(String externalId)
```
  - password
```
public SignUp password(String password)
```
  - getPassword
```
public String getPassword()
```
    User's password.
    
    Returns:
    
    password
  - setPassword
```
public void setPassword(String password)
```
  - consent
```
public SignUp consent(Boolean consent)
```
  - isConsent
```
public Boolean isConsent()
```
    **Create user API for admins only.** Create this user consented to all required consents. For testing purposes only.
    
    Returns:
    
    consent
  - setConsent
```
public void setConsent(Boolean consent)
```
  - getType
```
public String getType()
```
    SignUp
    
    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 SignUp

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SignUp

Method Detail

firstName

getFirstName

setFirstName

lastName

getLastName

setLastName

synapseUserId

getSynapseUserId

setSynapseUserId

getId

notifyByEmail

isNotifyByEmail

setNotifyByEmail

attributes

putAttributesItem

getAttributes

setAttributes

sharingScope

getSharingScope

setSharingScope

getCreatedOn

emailVerified

isEmailVerified

setEmailVerified

phoneVerified

isPhoneVerified

setPhoneVerified

status

getStatus

setStatus

roles

addRolesItem

getRoles

setRoles

dataGroups

addDataGroupsItem

getDataGroups

setDataGroups

clientData

getClientData

setClientData

languages

addLanguagesItem

getLanguages

setLanguages

getStudyIds

externalIds

putExternalIdsItem

getExternalIds

setExternalIds

orgMembership

getOrgMembership

setOrgMembership

note

getNote

setNote

clientTimeZone

getClientTimeZone

setClientTimeZone

appId

getAppId

setAppId

email

getEmail

setEmail

phone

getPhone

setPhone

externalId

getExternalId

setExternalId

password

getPassword