UserGroupManager Class

Service for managing users and groups

Definition

Namespace: FileHold.UserRoleManager
Assembly: FileHold.UserRoleManager (in FileHold.UserRoleManager.dll) Version: 17.1.0.0
C#
[WebServiceAttribute(Namespace = "http://filehold.com/userrolemanager/usergroupmanager/")]
[WebServiceBindingAttribute(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class UserGroupManager : WebService
Inheritance
Object    MarshalByValueComponent    WebService    UserGroupManager

Constructors

UserGroupManager constructor

Properties

Methods

AddDomain Add domain for synchronization.
AddDomainObjects Add selected domain objects to FileHold
AddFileHoldGroup Add new FileHold group to the system
AddLocalUser(LocalUserProperties, Boolean, Boolean) Add new local user to the system
AddLocalUser(LocalUserProperties, Boolean, Boolean, Boolean, Database, DbTransaction) 
AddOrUpdateExternalUserDetails(ExternalUserDetails) 
AddOrUpdateExternalUserDetails(ExternalUserDetails, Database, DbTransaction) 
AddSystemAuditLogEntry 
AddUserObjectsToFileHoldGroups Add selected users to one or more FileHold groups
AssignUserScanningInboxLicenses Assign Scanning Inbox license to selected users
AssignUserWebViewerLicenses Assign Web Viewer license to selected users
ChangeLocalUserPassword Change password of a specified locally managed user
ChangeUserAccountsState Enable or disable FileHold accounts for selected users
ChangeUserAccountState Enable or disable FileHold account for particular user
ChangeUserViewerLicenseType Assign Viewer License to a particular user
CheckADAMObjectGuids Checks what kind of user objects are identified by the collection of guids
CheckGuids Checks what kind of user objects are identified by the collection of guids
ClearPassword 
ClearSession Clear cache with domain objects
ConfirmEmail(String, Guid) Verify email address for the given external user.
ConfirmEmail(String, Guid, Database, DbTransaction) 
CreateSelfRegisterUser 
CreateSupportUser(SelfRegisterUser) 
CreateSupportUser(SelfRegisterUser, Database, DbTransaction) 
DeleteADAMObjects Delete selected ADAM objects
DeleteDomain Delete synchronized domain.
DeleteExternalUsers Delete external users with given IDs.
DeleteReportSettings Delete a named view for the grid of a given type.
ExecuteMassEditActions This method is obsolete, use ExecuteMassEditActionsV2 instead.
ExecuteMassEditActionsV2 Perform mass-edit actions on one or more users.
ExpandAllToMembers Expand all objects from given set of GUIDs into users. Only basic properties are returned, including ID, name, email and license status.
FindUserObject This method is obsolete, use GetUserObjectsV2 instead.
FindUserObjectCount This method is obsolete, use GetUserObjectsCountV2 instead.
FindUserObjectCountExcluding This method is obsolete, use GetUserObjectsCountV2 instead.
FindUserObjectExcluding This method is obsolete, use GetUserObjectsV2 instead.
GetActiveNonGuarantedSessionCount 
GetADAMObjectsFromIds Return ADAM objects with given identifiers. For regular users, the returned information includes the user GUID, names, type, enabled/disabled status, domain, email and work phone. For system administrators, all properties are returned.
GetAdditionalLogonSettings(String) 
GetAdditionalLogonSettings(String, Database, DbTransaction) 
GetAllowedOperations 
GetAllRoles Return all AzMan roles existing in the system
GetAllUsersAllowedToMakeOperations Returns list of all user allowed to perform at least one from specified operations. Only basic properties are returned, including ID, name, email and license status.
GetAssignedScanningInboxLicenses Return the number of assigned Scanning Inbox licenses
GetAssignedViewerLicenses Return the number of assigned Viewer licenses of the given type
GetAssignedWebViewerInboxLicenses Return the number of assigned Web Viewer Inbox licenses
GetAvailableAzRoles Returns available AzMan roles
GetAvailableCabinetOwners Return users and groups allowed to own a cabinet. Only basic properties are returned, including ID, name, email and license status.
GetAvailableFolderOwnersInCabinet(Guid, ObjectInRole) Return users who are allowed to own a folder in the particular cabinet. Only basic properties are returned, including ID, name, email and license status.
GetAvailableFolderOwnersInCabinet(Guid, ObjectInRole, Database, DbTransaction) 
GetAvailableLicenses 
GetAvailableLicenses(RoleType) Get number of available licenses for given license type.
GetAvailableUserPropertyValues Retrieve distinct values of a particular user property
GetAvailableViewerLicenses Return the number of available Viewer licenses of the given type
GetAzRoles Returns names of all AzMan roles existing in the system
Obsolete.
GetCurrentUser Return information about currently logged in user
GetDomainGroupDetails Return details of specified domain group
GetDomainStructure Retrieve the structure of a specified domain
GetDomainUserDetails Return details of specified domain user
GetEligibleUsers Retrieve users allowed to perform specified operations in a folder. Only basic properties are returned, including ID, name, email and license status.
GetEligibleUsersAndGroups Retrieve users and groups allowed to perform specified operations in a folder. Only basic properties are returned, including ID, name, email and license status.
GetExceededLoginAttempts 
GetExternalUsers Returns list of external users
GetFileholdGroupDetails Return details of specified FileHold group
GetFileholdGroups Return all available FileHold groups. This method only return basic properties which are relevant to FileHold groups, including ID, name, role, description and last modified date.
GetFileholdGroupsByRole Return FileHold groups filtered by roleId. This method only return basic properties which are relevant to FileHold groups, including ID, name, role, description and last modified date.
GetFileholdGroupsByRoleCount Return number of FileHold groups filtered by roleId.
GetFileholdGroupsByType Return FileHold groups filtered by role type. This method only return basic properties which are relevant to FileHold groups, including ID, name, role, description and last modified date.
GetFileholdGroupsByTypeCount Return number of FileHold groups filtered by role type
GetFileholdGroupsCount Return number of FileHold groups
GetFileholdGroupsExcluding Return FileHold groups excluding those with given permissions. This method only return basic properties which are relevant to FileHold groups, including ID, name, role and description.
GetFilterdSessionLogs Return information from the activity log with filtering
GetFilteredUserObjects Return filtered user objects (including local users, domain users and domain groups). For regular users, the returned information includes the user GUID, names, type, enabled/disabled status, domain, email and work phone. For system administrators, all properties are returned.
GetFilteredUserObjectsByRoleType Return filtered user objects with given user license (including local users, domain users and domain groups) For regular users, the returned information includes the user GUID, names, type, enabled/disabled status, domain, email and work phone. For system administrators, all properties are returned.
GetFilteredUserObjectsByRoleTypeCount Return the number of filtered user objects with given user license
GetFilteredUserObjectsCount Return the number of user objects (excluding FileHold groups) matching given filter
GetFilteredUsers Get the list of users with support for paging, sorting and filtering. All user properties are returned, including contact information.
GetFirstCharactersOfDomainObjects Return distinct first characters of user names from given domain
GetFirstCharactersOfNames Return distinct first characters of user names
GetGuaranteedAccessUsersCount Return number of users with guaranteed access to the system
GetInsufficientCALLogEntries 
GetInsufficientCALLogs Return information from the insufficient CAL log
GetInsufficientCALLogsByUserGuid Return information from the insufficient CAL log
GetInsufficientLicenses 
GetIsRemoveLicenseFromDisabledDomainUsers 
GetLicensedUsersCount Return number of licensed FileHold users
GetLicensedUsersCountByType Return number of licensed FileHold users with gien license type.
GetLocalUserDetails Return details of specified locally managed user
GetLogonAndPasswordSecuritySettings Return logon and password security settings
GetMemberUsersOfFileholdGroups Retrieves all users belonging to specified FileHold groups. Only basic properties are returned, including ID, name, email and license status.
GetObjectsContains Find objects from specified domain container containing specified string
GetObjectsFromContainer Retrieve objects which belong directly to specified domain container and were not added to FileHold
GetObjectsStartWith Find objects from specified domain container starting with specified string
GetRestricedAccessSetting 
GetSelectedUsersDetails Return statistics about selected users.
GetSessionLogs Return information from the activity log
GetShowNewFeatureIntroMessage Checks if a specific message was marked to be shown.
Obsolete.
GetStoredDomain Return information about specified synchronized domain
GetStoredDomains Return domains stored in system
GetSupportUsers 
GetSystemAuditLogs 
GetSystemAuditLogsByGuid 
GetUserObjects This method is obsolete, use GetUserObjectsV2 instead.
GetUserObjectsCount This method is obsolete, use GetUserObjectsCountV2 instead.
GetUserObjectsCountV2 Return the number of user objects (including local users, domain users and optionally domain groups), optionally matching given filter.
GetUserObjectsV2 Return all user objects (including local users, domain users and optionally domain groups), optionally matching given filter. When both name and email are null or empty strings, all user objects in the system are returned, including disabled users and optionally domain groups. The returned information includes the user GUID, names, type, enabled/disabled status, authentication type, domain, email and work phone. In some situations it may be more efficient to call this function only once to get all users, cache the result and perform the search manually.
GetUserReportPageSize 
GetUsersAllowedToMakeOperations Return users allowed to perform specified operations. Only basic properties are returned, including ID, name, email and license status.
GetUsersAndGroupsAllowedToMakeOperations Return users and groups allowed to perform specified operations. Only basic properties are returned, including ID, name, email and license status.
GetUsersCount Return number of all users in the system
GetUserSelfRegistrationSettings(Boolean, Boolean, Guid) Return configuration of the user self registration process
GetUserSelfRegistrationSettings(Boolean, Boolean, Guid, Database, DbTransaction) 
GetUsersWithSpecifiedProperties Retrieve users with particular property set to one of the specified values. Only user IDs and names are returned.
InitializeAutomaticResetPassword Automatic reset password of a specified locally manager users
InvokeUserAction Invoke a user action from plug-in
IsMiddleInitialInFullNameEnabled 
LoadReportSetting Load a named view for the grid of a given type.
LoadUserReportSettings Return all views for the grid of a given type.
MemberOfDistinctFHGroups(Guid) 
MemberOfDistinctFHGroups(Guid, Database, DbTransaction) 
RebuildCacheWebMethod This method is obsolete.
ResendExternalUserEmailConfirmation(Guid) Resend confirmation email for the given external user.
ResendExternalUserEmailConfirmation(Guid, Database, DbTransaction) 
ResetLocalUserPassword Reset password of a specified locally managed user
RollbackEmailChange(String, Guid) 
RollbackEmailChange(String, Guid, Database, DbTransaction) 
SaveReportSetting Save default or named view for the grid of a given type. The view includes column order, sorting, grouping and filtering.
SaveUserReportPageSize 
SetAsLicensed Enable FileHold license for selected users
SetAuthenticatorKey 
SetDefaultDomain Set the default domain for logon
SetDomainGroupProperties Modify properties of specified domain group
SetDomainUserProperties Modify properties of specified domain user
SetDoNotShowNewFeatureIntroMessage Mark the 'New Feature Introduction' message not to be shown in the future for current user.
Obsolete.
SetExternalUserEnabled Enable or disable external user. Use SetExternalUserEnabledV2 instead.
SetExternalUserEnabledV2 Enable or disable external user
SetFileholdGroupProperties Modify properties of specified FileHold group
SetIsRemoveLicenseFromDisabledDomainUsers Configure removing license from users disabled in domain
SetLanguagePreference Set language for the current session
SetLocalUserDetails This method is obsolete, use SetLocalUserDetailsV2 instead.
SetLocalUserDetailsV2 Update the first and last name, email and contact details of a locally managed user. This method can only be called by the user that's being updated. The ID property of LocalUserDetails is ignored.
SetLocalUserProperties Modify properties of specified locally managed user
SetLogonAndPasswordSecuritySettings Configure logon and password security settings
SetRestricedAccessSetting 
SetUserGuaranteedAccess Enable or disable guaranteed access for particular user
SetUserSelfRegistrationSettings Configure user self registration process
SetUsersFullName Update users full name
SetUserViewerLicenses Assign Viewer license to selected users
SynchronizeDomain Synchronize the given domain.
UpdateBasicUserDetails Update selected user properties. This method is used by the users grid and updates account state, guaranteed access, viewer and scanning inbox license and optionally assigned groups.
UpdateDomain Update synchronized domain information.
UpdateDomainFromADAM Obsolete method.

Extension Methods

See Also