Uses of Class
com.mypurecloud.sdk.v2.model.User

Packages that use User

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.model

Uses of User in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return User

Modifier and Type	Method	Description
User	UsersApi.getUser(GetUserRequest request)	Get user.
User	UsersApi.getUser(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)	Get user.
User	UsersApi.getUsersExternalidAuthorityNameExternalKey(GetUsersExternalidAuthorityNameExternalKeyRequest request)	Get the user associated with external identifier.
User	UsersApi.getUsersExternalidAuthorityNameExternalKey(String authorityName, String externalKey, List<String> expand)	Get the user associated with external identifier.
User	UsersApi.patchUser(PatchUserRequest request)	Update user
User	UsersApi.patchUser(String userId, UpdateUser body)	Update user
User	UsersApi.postUsers(PostUsersRequest request)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
User	UsersApi.postUsers(CreateUser body)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type User

Modifier and Type	Method	Description
ApiResponse<User>	UsersApi.getUser(ApiRequest<Void> request)	Get user.
Future<User>	UsersApiAsync.getUserAsync(GetUserRequest request, AsyncApiCallback<User> callback)	Get user.
Future<ApiResponse<User>>	UsersApiAsync.getUserAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<User>> callback)	Get user.
List<User>	UsersApi.getUserDirectreports(GetUserDirectreportsRequest request)	Get direct reports
ApiResponse<List<User>>	UsersApi.getUserDirectreports(ApiRequest<Void> request)	Get direct reports
List<User>	UsersApi.getUserDirectreports(String userId, List<String> expand)	Get direct reports
Future<List<User>>	UsersApiAsync.getUserDirectreportsAsync(GetUserDirectreportsRequest request, AsyncApiCallback<List<User>> callback)	Get direct reports
Future<ApiResponse<List<User>>>	UsersApiAsync.getUserDirectreportsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<User>>> callback)	Get direct reports
ApiResponse<List<User>>	UsersApi.getUserDirectreportsWithHttpInfo(String userId, List<String> expand)	Get direct reports
ApiResponse<User>	UsersApi.getUsersExternalidAuthorityNameExternalKey(ApiRequest<Void> request)	Get the user associated with external identifier.
Future<User>	UsersApiAsync.getUsersExternalidAuthorityNameExternalKeyAsync(GetUsersExternalidAuthorityNameExternalKeyRequest request, AsyncApiCallback<User> callback)	Get the user associated with external identifier.
Future<ApiResponse<User>>	UsersApiAsync.getUsersExternalidAuthorityNameExternalKeyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<User>> callback)	Get the user associated with external identifier.
ApiResponse<User>	UsersApi.getUsersExternalidAuthorityNameExternalKeyWithHttpInfo(String authorityName, String externalKey, List<String> expand)	Get the user associated with external identifier.
List<User>	UsersApi.getUserSuperiors(GetUserSuperiorsRequest request)	Get superiors
ApiResponse<List<User>>	UsersApi.getUserSuperiors(ApiRequest<Void> request)	Get superiors
List<User>	UsersApi.getUserSuperiors(String userId, List<String> expand)	Get superiors
Future<List<User>>	UsersApiAsync.getUserSuperiorsAsync(GetUserSuperiorsRequest request, AsyncApiCallback<List<User>> callback)	Get superiors
Future<ApiResponse<List<User>>>	UsersApiAsync.getUserSuperiorsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<User>>> callback)	Get superiors
ApiResponse<List<User>>	UsersApi.getUserSuperiorsWithHttpInfo(String userId, List<String> expand)	Get superiors
ApiResponse<User>	UsersApi.getUserWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)	Get user.
ApiResponse<User>	UsersApi.patchUser(ApiRequest<UpdateUser> request)	Update user
Future<User>	UsersApiAsync.patchUserAsync(PatchUserRequest request, AsyncApiCallback<User> callback)	Update user
Future<ApiResponse<User>>	UsersApiAsync.patchUserAsync(ApiRequest<UpdateUser> request, AsyncApiCallback<ApiResponse<User>> callback)	Update user
ApiResponse<User>	UsersApi.patchUserWithHttpInfo(String userId, UpdateUser body)	Update user
ApiResponse<User>	UsersApi.postUsers(ApiRequest<CreateUser> request)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
Future<User>	UsersApiAsync.postUsersAsync(PostUsersRequest request, AsyncApiCallback<User> callback)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
Future<ApiResponse<User>>	UsersApiAsync.postUsersAsync(ApiRequest<CreateUser> request, AsyncApiCallback<ApiResponse<User>> callback)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
ApiResponse<User>	UsersApi.postUsersWithHttpInfo(CreateUser body)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type User

Modifier and Type	Method	Description
Future<User>	UsersApiAsync.getUserAsync(GetUserRequest request, AsyncApiCallback<User> callback)	Get user.
Future<ApiResponse<User>>	UsersApiAsync.getUserAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<User>> callback)	Get user.
Future<List<User>>	UsersApiAsync.getUserDirectreportsAsync(GetUserDirectreportsRequest request, AsyncApiCallback<List<User>> callback)	Get direct reports
Future<ApiResponse<List<User>>>	UsersApiAsync.getUserDirectreportsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<User>>> callback)	Get direct reports
Future<User>	UsersApiAsync.getUsersExternalidAuthorityNameExternalKeyAsync(GetUsersExternalidAuthorityNameExternalKeyRequest request, AsyncApiCallback<User> callback)	Get the user associated with external identifier.
Future<ApiResponse<User>>	UsersApiAsync.getUsersExternalidAuthorityNameExternalKeyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<User>> callback)	Get the user associated with external identifier.
Future<List<User>>	UsersApiAsync.getUserSuperiorsAsync(GetUserSuperiorsRequest request, AsyncApiCallback<List<User>> callback)	Get superiors
Future<ApiResponse<List<User>>>	UsersApiAsync.getUserSuperiorsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<User>>> callback)	Get superiors
Future<User>	UsersApiAsync.patchUserAsync(PatchUserRequest request, AsyncApiCallback<User> callback)	Update user
Future<ApiResponse<User>>	UsersApiAsync.patchUserAsync(ApiRequest<UpdateUser> request, AsyncApiCallback<ApiResponse<User>> callback)	Update user
Future<User>	UsersApiAsync.postUsersAsync(PostUsersRequest request, AsyncApiCallback<User> callback)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
Future<ApiResponse<User>>	UsersApiAsync.postUsersAsync(ApiRequest<CreateUser> request, AsyncApiCallback<ApiResponse<User>> callback)	Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.

Uses of User in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return User

Modifier and Type	Method	Description
User	User.acdAutoAnswer(Boolean acdAutoAnswer)	acd auto answer
User	User.addresses(List<Contact> addresses)	Email addresses and phone numbers for this user
User	User.biography(Biography biography)
User	User.certifications(List<String> certifications)
User	User.chat(Chat chat)
User	User.department(String department)
User	User.division(Division division)	The division to which this entity belongs.
User	User.email(String email)
User	User.employerInfo(EmployerInfo employerInfo)
User	AgentActivity.getAgent()
User	AgentEvaluatorActivity.getAgent()
User	Calibration.getAgent()
User	CalibrationCreate.getAgent()
User	Evaluation.getAgent()
User	EvaluationResponse.getAgent()
User	EvaluationSearchItemResponse.getAgent()
User	Evaluation.getAssignee()
User	EvaluationResponse.getAssignee()
User	EvaluationSearchItemResponse.getAssignee()
User	UserStation.getAssociatedUser()
User	Calibration.getCalibrator()
User	CalibrationAssignment.getCalibrator()
User	CalibrationCreate.getCalibrator()
User	VoicemailMessage.getCallerUser()
User	FlowVersion.getCreatedBy()
User	Library.getCreatedBy()
User	MessageData.getCreatedBy()
User	Note.getCreatedBy()
User	OrganizationPresence.getCreatedBy()
User	Recipient.getCreatedBy()
User	Response.getCreatedBy()
User	SmsPhoneNumber.getCreatedBy()
User	SocialMediaMessageData.getCreatedBy()
User	UserStation.getDefaultUser()
User	AgentEvaluatorActivity.getEvaluator()
User	Evaluation.getEvaluator()
User	EvaluationResponse.getEvaluator()
User	EvaluationSearchItemResponse.getEvaluator()
User	EvaluatorActivity.getEvaluator()
User	Calibration.getExpertEvaluator()
User	CalibrationAssignment.getExpertEvaluator()
User	CalibrationCreate.getExpertEvaluator()
User	RecordingMessagingMessage.getFromUser()
User	Flow.getLockedUser()
User	OrgUser.getManager()
User	PolicyUser.getManager()
User	TrustUser.getManager()
User	User.getManager()
User	UserMe.getManager()
User	OrganizationPresence.getModifiedBy()
User	Recipient.getModifiedBy()
User	SmsPhoneNumber.getModifiedBy()
User	Flow.getPublishedBy()
User	Annotation.getUser()
User	CallForwarding.getUser()
User	CallHistoryParticipant.getUser()
User	DependencyStatus.getUser()
User	DomainResourceConditionValue.getUser()
User	EncryptionKey.getUser()
User	EvaluationAssignment.getUser()
User	HistoryEntry.getUser()
User	HistoryListing.getUser()
User	Operation.getUser()
User	OutOfOffice.getUser()
User	QueueMember.getUser()
User	Relationship.getUser()
User	Share.getUser()
User	VoicemailCopyRecord.getUser()
User	VoicemailMessage.getUser()
User	WorkspaceMember.getUser()
User	User.images(List<Image> images)
User	User.lastTokenIssued(OAuthLastTokenIssued lastTokenIssued)
User	User.manager(User manager)
User	User.name(String name)
User	User.preferredName(String preferredName)	Preferred full name of the agent
User	User.title(String title)
User	User.username(String username)
User	User.version(Integer version)	Required when updating a user, this value should be the current version of the user.

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type User

Modifier and Type	Method	Description
List<User>	Adjacents.getDirectReports()
List<User>	UserMe.getDirectReports()
List<User>	UserCursorEntityListing.getEntities()
List<User>	UserEntityListing.getEntities()
List<User>	Calibration.getEvaluators()
List<User>	CalibrationAssignment.getEvaluators()
List<User>	CalibrationCreate.getEvaluators()
List<User>	MeteredAssignmentByAgent.getEvaluators()
List<User>	MeteredEvaluationAssignment.getEvaluators()
List<User>	UserMe.getFavorites()
List<User>	Group.getOwners()
List<User>	TrustGroup.getOwners()
List<User>	UsersSearchResponse.getResults()
List<User>	Adjacents.getSiblings()
List<User>	Adjacents.getSuperiors()
List<User>	UserMe.getSuperiors()
List<User>	Recording.getUsers()

Methods in com.mypurecloud.sdk.v2.model with parameters of type User

Modifier and Type	Method	Description
AgentActivity	AgentActivity.agent(User agent)
AgentEvaluatorActivity	AgentEvaluatorActivity.agent(User agent)
Calibration	Calibration.agent(User agent)
CalibrationCreate	CalibrationCreate.agent(User agent)
Evaluation	Evaluation.agent(User agent)
EvaluationResponse	EvaluationResponse.agent(User agent)
EvaluationSearchItemResponse	EvaluationSearchItemResponse.agent(User agent)
Evaluation	Evaluation.assignee(User assignee)
EvaluationResponse	EvaluationResponse.assignee(User assignee)
EvaluationSearchItemResponse	EvaluationSearchItemResponse.assignee(User assignee)
UserStation	UserStation.associatedUser(User associatedUser)
Calibration	Calibration.calibrator(User calibrator)
CalibrationAssignment	CalibrationAssignment.calibrator(User calibrator)
CalibrationCreate	CalibrationCreate.calibrator(User calibrator)
FlowVersion	FlowVersion.createdBy(User createdBy)
MessageData	MessageData.createdBy(User createdBy)	User who sent this message.
Note	Note.createdBy(User createdBy)	When creating or updating a note, only User.id is required.
OrganizationPresence	OrganizationPresence.createdBy(User createdBy)
Recipient	Recipient.createdBy(User createdBy)	User that created this recipient
SmsPhoneNumber	SmsPhoneNumber.createdBy(User createdBy)	User that provisioned this phone number
SocialMediaMessageData	SocialMediaMessageData.createdBy(User createdBy)	User who sent this message.
UserStation	UserStation.defaultUser(User defaultUser)
AgentEvaluatorActivity	AgentEvaluatorActivity.evaluator(User evaluator)
Evaluation	Evaluation.evaluator(User evaluator)
EvaluationResponse	EvaluationResponse.evaluator(User evaluator)
EvaluationSearchItemResponse	EvaluationSearchItemResponse.evaluator(User evaluator)
EvaluatorActivity	EvaluatorActivity.evaluator(User evaluator)
Calibration	Calibration.expertEvaluator(User expertEvaluator)
CalibrationAssignment	CalibrationAssignment.expertEvaluator(User expertEvaluator)
CalibrationCreate	CalibrationCreate.expertEvaluator(User expertEvaluator)
RecordingMessagingMessage	RecordingMessagingMessage.fromUser(User fromUser)	The user who sent this message.
Flow	Flow.lockedUser(User lockedUser)	User that has the flow locked.
OrgUser	OrgUser.manager(User manager)
PolicyUser	PolicyUser.manager(User manager)
TrustUser	TrustUser.manager(User manager)
User	User.manager(User manager)
UserMe	UserMe.manager(User manager)
OrganizationPresence	OrganizationPresence.modifiedBy(User modifiedBy)
Recipient	Recipient.modifiedBy(User modifiedBy)	User that modified this recipient
SmsPhoneNumber	SmsPhoneNumber.modifiedBy(User modifiedBy)	User that last modified this phone number
Flow	Flow.publishedBy(User publishedBy)
void	AgentActivity.setAgent(User agent)
void	AgentEvaluatorActivity.setAgent(User agent)
void	Calibration.setAgent(User agent)
void	CalibrationCreate.setAgent(User agent)
void	Evaluation.setAgent(User agent)
void	EvaluationResponse.setAgent(User agent)
void	EvaluationSearchItemResponse.setAgent(User agent)
void	Evaluation.setAssignee(User assignee)
void	EvaluationResponse.setAssignee(User assignee)
void	EvaluationSearchItemResponse.setAssignee(User assignee)
void	UserStation.setAssociatedUser(User associatedUser)
void	Calibration.setCalibrator(User calibrator)
void	CalibrationAssignment.setCalibrator(User calibrator)
void	CalibrationCreate.setCalibrator(User calibrator)
void	FlowVersion.setCreatedBy(User createdBy)
void	MessageData.setCreatedBy(User createdBy)
void	Note.setCreatedBy(User createdBy)
void	OrganizationPresence.setCreatedBy(User createdBy)
void	Recipient.setCreatedBy(User createdBy)
void	SmsPhoneNumber.setCreatedBy(User createdBy)
void	SocialMediaMessageData.setCreatedBy(User createdBy)
void	UserStation.setDefaultUser(User defaultUser)
void	AgentEvaluatorActivity.setEvaluator(User evaluator)
void	Evaluation.setEvaluator(User evaluator)
void	EvaluationResponse.setEvaluator(User evaluator)
void	EvaluationSearchItemResponse.setEvaluator(User evaluator)
void	EvaluatorActivity.setEvaluator(User evaluator)
void	Calibration.setExpertEvaluator(User expertEvaluator)
void	CalibrationAssignment.setExpertEvaluator(User expertEvaluator)
void	CalibrationCreate.setExpertEvaluator(User expertEvaluator)
void	RecordingMessagingMessage.setFromUser(User fromUser)
void	Flow.setLockedUser(User lockedUser)
void	OrgUser.setManager(User manager)
void	PolicyUser.setManager(User manager)
void	TrustUser.setManager(User manager)
void	User.setManager(User manager)
void	UserMe.setManager(User manager)
void	OrganizationPresence.setModifiedBy(User modifiedBy)
void	Recipient.setModifiedBy(User modifiedBy)
void	SmsPhoneNumber.setModifiedBy(User modifiedBy)
void	Flow.setPublishedBy(User publishedBy)
void	Annotation.setUser(User user)
void	CallForwarding.setUser(User user)
void	CallHistoryParticipant.setUser(User user)
void	DependencyStatus.setUser(User user)
void	DomainResourceConditionValue.setUser(User user)
void	EncryptionKey.setUser(User user)
void	EvaluationAssignment.setUser(User user)
void	HistoryEntry.setUser(User user)
void	HistoryListing.setUser(User user)
void	Operation.setUser(User user)
void	OutOfOffice.setUser(User user)
void	QueueMember.setUser(User user)
void	Relationship.setUser(User user)
void	Share.setUser(User user)
void	WorkspaceMember.setUser(User user)
Annotation	Annotation.user(User user)	User that created this annotation (if any).
CallForwarding	CallForwarding.user(User user)
CallHistoryParticipant	CallHistoryParticipant.user(User user)	The PureCloud user for this participant.
DependencyStatus	DependencyStatus.user(User user)	User that initiated the build.
DomainResourceConditionValue	DomainResourceConditionValue.user(User user)
EncryptionKey	EncryptionKey.user(User user)	user that requested generation of public key
EvaluationAssignment	EvaluationAssignment.user(User user)
HistoryEntry	HistoryEntry.user(User user)	User associated with this entry.
HistoryListing	HistoryListing.user(User user)
Operation	Operation.user(User user)
OutOfOffice	OutOfOffice.user(User user)
QueueMember	QueueMember.user(User user)
Relationship	Relationship.user(User user)	The user associated with the external organization.
Share	Share.user(User user)
WorkspaceMember	WorkspaceMember.user(User user)

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type User

Modifier and Type	Method	Description
Adjacents	Adjacents.directReports(List<User> directReports)
UserCursorEntityListing	UserCursorEntityListing.entities(List<User> entities)
UserEntityListing	UserEntityListing.entities(List<User> entities)
Calibration	Calibration.evaluators(List<User> evaluators)
CalibrationAssignment	CalibrationAssignment.evaluators(List<User> evaluators)
CalibrationCreate	CalibrationCreate.evaluators(List<User> evaluators)
MeteredAssignmentByAgent	MeteredAssignmentByAgent.evaluators(List<User> evaluators)
MeteredEvaluationAssignment	MeteredEvaluationAssignment.evaluators(List<User> evaluators)
Group	Group.owners(List<User> owners)	Owners of the group
TrustGroup	TrustGroup.owners(List<User> owners)	Owners of the group
UsersSearchResponse	UsersSearchResponse.results(List<User> results)	Search results
void	Adjacents.setDirectReports(List<User> directReports)
void	UserCursorEntityListing.setEntities(List<User> entities)
void	UserEntityListing.setEntities(List<User> entities)
void	Calibration.setEvaluators(List<User> evaluators)
void	CalibrationAssignment.setEvaluators(List<User> evaluators)
void	CalibrationCreate.setEvaluators(List<User> evaluators)
void	MeteredAssignmentByAgent.setEvaluators(List<User> evaluators)
void	MeteredEvaluationAssignment.setEvaluators(List<User> evaluators)
void	Group.setOwners(List<User> owners)
void	TrustGroup.setOwners(List<User> owners)
void	UsersSearchResponse.setResults(List<User> results)
void	Adjacents.setSiblings(List<User> siblings)
void	Adjacents.setSuperiors(List<User> superiors)
void	Recording.setUsers(List<User> users)
Adjacents	Adjacents.siblings(List<User> siblings)
Adjacents	Adjacents.superiors(List<User> superiors)
Recording	Recording.users(List<User> users)	The users participating in the conversation