IUserService1

Operations

NameSignatureDescription
BulkGetUserDetailsUserDetails1[] BulkGetUserDetails(Uri[] userUri)Retrieve user details given a user URI.
BulkGetUsersUserReference1[] BulkGetUsers(Uri[] userUris)Retrieve user references given a user Uri list.
BulkGetUsers2UserReference1[] BulkGetUsers2(UserTargetParameter1[] users)Retrieve user references given a user Uri/login name list.
CreateEditDraftUri CreateEditDraft(Uri userUri)Create a draft of an existing user.
CreateNewDraftUri CreateNewDraft()Create a new user draft.
CreateObjectSetUri CreateObjectSet(Uri[] userUris)Operation CreateObjectSet
CreateUserDeleteBatchUri CreateUserDeleteBatch(Uri[] userUris, Uri userBulkDeleteOptionUri)Create a batch for bulk deleting users
CreateUserDeleteBatch2Uri CreateUserDeleteBatch2(UserTargetParameter1[] users, Uri userBulkDeleteOptionUri)Create a batch for bulk deleting users by target
Deletevoid Delete(Uri userUri)Delete a user
DeleteSupervisorAssignmentScheduleEntryvoid DeleteSupervisorAssignmentScheduleEntry(Uri supervisorAssignmentScheduleEntryUri)Operation DeleteSupervisorAssignmentScheduleEntry
ExecuteUserDeleteBatchUserDeleteBatchResults1 ExecuteUserDeleteBatch(Uri userDeleteBatchUri)Delete many users
GetAllUsersUserReference1[] GetAllUsers()Retrieve all users.
GetCountOfUsersInPolicyDataAccessScopeInt32 GetCountOfUsersInPolicyDataAccessScope(Uri policyUri, UserSearchParameter1 userSearch)Get the total number of users who are accessable for the given policy
GetDirectReportsForUserUserReference1[] GetDirectReportsForUser(Uri userUri, Date1 asOfDate, Uri userStatusOptionUri)Get the list of users who are the direct reports of a given supervisor, as of a certain date.
GetEligibleSupervisorsSupervisorReference1[] GetEligibleSupervisors(Uri userUri)Retrieves all eligible supervisors for the specified user.
GetEmailFormulaForNewUsersString GetEmailFormulaForNewUsers()Get the formula to use for the default internal email address for new users
GetEnabledUsersUserReference1[] GetEnabledUsers()Retrieve all users who are currently enabled for login.
GetPageOfUsersInPolicyDataAccessScope2UserSearchResult1[] GetPageOfUsersInPolicyDataAccessScope2(Int32 pageIndex, Int32 pageSize, Uri policyUri, UserSearchParameter1 userSearch)Get a page of users who are accessable for the given policy
GetSupervisorAssignmentDetailsSupervisorAssignmentScheduleEntryDetails1 GetSupervisorAssignmentDetails(Uri userUri, Date1 asOfDate)Get the supervisor assignment schedule for the specified user on the specified date, or today if not specified
GetSupervisorAssignmentScheduleSupervisorAssignmentScheduleEntryDetails1[] GetSupervisorAssignmentSchedule(Uri userUri)Get the supervisor assignment schedule for the specified user
GetUriFromSlugUri GetUriFromSlug(String userSlug)Convert a user slug into a URI.
GetUserUserReference1 GetUser(Uri userUri)Retrieve user reference given a user URI.
GetUser2UserReference1 GetUser2(UserTargetParameter1 user)Retrieve a user reference given a user target parameter.
GetUserDeleteBatchResultsUserDeleteBatchResults1 GetUserDeleteBatchResults(Uri userDeleteBatchUri)Retrieve results of a completed ExecuteUserDeleteBatch operation. Returns null if the batch has not completed.
GetUserDeleteBatchResults2UserDeleteBatchResults2 GetUserDeleteBatchResults2(Uri userDeleteBatchUri)Retrieve results of a completed CreateUserDeleteBatch2 operation. Returns null if the batch has not completed.
GetUserDetailsUserDetails1 GetUserDetails(Uri userUri)Retrieve user details given a user URI.
GetWorkWeekStartDayForNewUsersDayOfWeekReference1 GetWorkWeekStartDayForNewUsers()Get the work week start day to use as a default for new users
GetWorkWeekStartDayForUserDayOfWeekReference1 GetWorkWeekStartDayForUser(Uri userUri)Get the work week start to use for the specified user
PublishDraftUserReference1 PublishDraft(Uri draftUri)Publish the user draft into a persisted user.
PutSupervisorAssignmentSchedulevoid PutSupervisorAssignmentSchedule(Uri userUri, Uri initialSupervisorUri, SupervisorAssignmentScheduleEntryParameter1[] scheduleEntries)Put the entire supervisor assignment schedule for the specified user
PutSupervisorAssignmentSchedule2void PutSupervisorAssignmentSchedule2(Uri userUri, SupervisorAssignmentScheduleEntryParameter1[] scheduleEntries)Put the entire supervisor assignment schedule for the specified user
PutUserUserReference1 PutUser(UserParameter1 user)This operation is for importing or adding a user - if a UserParameter1.target.loginName is specified and not found, it will create that user
UpdateEmailvoid UpdateEmail(Uri userUri, String email)Modify the email of a user or user draft.
UpdateEmailFormulaForNewUsersvoid UpdateEmailFormulaForNewUsers(String formula)Change the formula to use for the default internal email address for new users
UpdateEmployeeIdvoid UpdateEmployeeId(Uri userUri, String employeeId)Update the user's employee ID
UpdateEmploymentDateRangevoid UpdateEmploymentDateRange(Uri userUri, DateRangeParameter1 dateRange)Update the employment date range for the specified user
UpdateFirstNamevoid UpdateFirstName(Uri userUri, String firstname)Modify the firstname of a user or user draft.
UpdateLastNamevoid UpdateLastName(Uri userUri, String lastname)Modify the lastname of a user or user draft.
UpdateSupervisorAssignmentScheduleEntryEffectiveDatevoid UpdateSupervisorAssignmentScheduleEntryEffectiveDate(Uri supervisorAssignmentScheduleEntryUri, Date1 effectiveDate)Update the effective date associated with the specified supervisor assignment schedule entry
UpdateSupervisorAssignmentScheduleEntrySupervisorvoid UpdateSupervisorAssignmentScheduleEntrySupervisor(Uri supervisorAssignmentScheduleEntryUri, Uri supervisorUri)Update the supervior associated with the specified supervisor assignment schedule entry
UpdateSupervisorAssignmentScheduleOverDateRangevoid UpdateSupervisorAssignmentScheduleOverDateRange(Uri userUri, Uri supervisorUri, DateRangeParameter1 dateRange)Updates which supervisor this user is assigned to for the given date range
UpdateWorkWeekStartDayForNewUsersvoid UpdateWorkWeekStartDayForNewUsers(Uri dayOfWeekUri)Change the work week start to use as a default value for new users
UpdateWorkWeekStartDayForUservoid UpdateWorkWeekStartDayForUser(Uri userUri, Uri dayOfWeekUri)Change the work week start to use for the specified user