org.sagebionetworks.bridge.rest.model

Class AccountSummary

java.lang.Object

org.sagebionetworks.bridge.rest.model.AccountSummary

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

Summary of a participant, used in APIs to search and retrieve participant accounts. This payload is returned from the API, but is never submitted to the API.

Constructor Summary

Constructors

Constructor and Description
AccountSummary()

Method Summary

Modifier and Type	Method and Description
AccountSummary	addDataGroupsItem(String dataGroupsItem)
AccountSummary	addRolesItem(Role rolesItem)
AccountSummary	attributes(Map<String,String> attributes)
AccountSummary	dataGroups(List<String> dataGroups)
boolean	equals(Object o)
String	getAppId() Get appId
Map<String,String>	getAttributes() Get attributes
String	getClientTimeZone() Participant's time zone.
DateTime	getCreatedOn() ISO 8601 date and time that the user account was created.
List<String>	getDataGroups() The data groups set for this user.
String	getEmail() Email address of user.
Map<String,String>	getExternalIds() A map of study ID to external ID for all the external IDs that have been assigned to this participant.
String	getFirstName() First (given) name of user.
String	getId() An identifier assigned to this user, used to retrieve a study participant record.
String	getLastName() Last (family) name of 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).
Phone	getPhone() Get phone
List<Role>	getRoles() Get roles
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() AccountSummary
int	hashCode()
AccountSummary	putAttributesItem(String key, String attributesItem)
AccountSummary	roles(List<Role> roles)
void	setAttributes(Map<String,String> attributes)
void	setDataGroups(List<String> dataGroups)
void	setRoles(List<Role> roles)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccountSummary

public AccountSummary()

Method Detail

getAppId

public String getAppId()

Get appId

Returns:

appId

getFirstName

public String getFirstName()

First (given) name of user.

Returns:

firstName

getLastName

public String getLastName()

Last (family) name of user.

Returns:

lastName

getEmail

public String getEmail()

Email address of user.

Returns:

email

getPhone

public Phone getPhone()

Get phone

Returns:

phone

getId

public String getId()

An identifier assigned to this user, used to retrieve a study participant record.

Returns:

id

getCreatedOn

public DateTime getCreatedOn()

ISO 8601 date and time that the user account was created.

Returns:

createdOn

getStatus

public AccountStatus getStatus()

Get status

Returns:

status

getStudyIds

public List<String> getStudyIds()

The studies this participant is associated to. This array does not include studies the participant has withdrawn from.

Returns:

studyIds

getExternalIds

public Map<String,String> getExternalIds()

A map of study ID to external ID for all the external IDs that have been assigned to this participant. This mapping does not include studies the participant has withdrawn from.

Returns:

externalIds

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.

Returns:

synapseUserId

attributes

public AccountSummary attributes(Map<String,String> attributes)

putAttributesItem

public AccountSummary putAttributesItem(String key,
                                        String attributesItem)

getAttributes

public Map<String,String> getAttributes()

Get attributes

Returns:

attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

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

roles

public AccountSummary roles(List<Role> roles)

addRolesItem

public AccountSummary addRolesItem(Role rolesItem)

getRoles

public List<Role> getRoles()

Get roles

Returns:

roles

setRoles

public void setRoles(List<Role> roles)

dataGroups

public AccountSummary dataGroups(List<String> dataGroups)

addDataGroupsItem

public AccountSummary 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)

getNote

public String getNote()

Optional note related to user account.

Returns:

note

getClientTimeZone

public String getClientTimeZone()

Participant's time zone. Can be updated or deleted. Must be an IANA time zone name.

Returns:

clientTimeZone

getType

public String getType()

AccountSummary

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