UserGroupManager Methods |
The UserGroupManager type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddDomain | |
| 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) | |
| ConfirmEmail(String, Guid, Database, DbTransaction) | |
| CreateSelfRegisterUser | |
| DeleteADAMObjects |
Delete selected ADAM objects
|
| DeleteDomain | |
| DeleteExternalUsers | |
| DeleteReportSettings | |
| ExecuteMassEditActions | |
| ExecuteMassEditActionsV2 | |
| ExpandAllToMembers |
Expand all objects from given set of guids into users
|
| FindUserObject |
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.
This method is similar to GetUserObjects, but allows excluding domain groups from the results.
The returned information includes the user GUID, names, type, enabled/disabled status, 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.
|
| FindUserObjectCount |
Return number of user objects (excluding FileHold groups) matching given name and/or email
|
| FindUserObjectCountExcluding |
Return number of user objects excluding those with given permissions
|
| FindUserObjectExcluding |
Find user objects excluding those with given permissions
|
| GetActiveNonGuarantedSessionCount | |
| GetADAMObjectsFromIds |
Return ADAM objects with given identifiers
|
| GetAdditionalLogonSettings(String) | |
| GetAdditionalLogonSettings(String, Database, DbTransaction) | |
| GetAllRoles |
Return all AzMan roles existing in the system
|
| GetAllUsersAllowedToMakeOperations |
Returns list of all user allowed to perform at least one from specified operations
|
| 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 | |
| GetAvailableCabinetOwners |
Return users and groups allowed to own a cabinet
|
| GetAvailableFolderOwnersInCabinet |
Return users who are allowed to own a folder in the particular cabinet
|
| GetAvailableLicenses | |
| GetAvailableLicenses(RoleType) |
Get number of available licenses for given license type.
|
| GetAvailableUserPropertyValues |
Retrieve distinct values of a particular user property
|
| GetAvailableViewerLicenses | |
| GetAzRoles | Obsolete.
Returns names of all AzMan roles existing in the system
|
| 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 alowed to perform specified operations in a folder
|
| GetEligibleUsersAndGroups |
Retrieve users and groups alowed to perform specified operations in a folder
|
| GetExceededLoginAttempts | |
| GetExternalUsers | |
| GetFileholdGroupDetails |
Return details of specified FileHold group
|
| GetFileholdGroups |
Return all available FileHold groups
|
| GetFileholdGroupsByRole | |
| GetFileholdGroupsByRoleCount |
Return number of FileHold groups
|
| GetFileholdGroupsByType | |
| GetFileholdGroupsByTypeCount | |
| GetFileholdGroupsCount |
Return number of FileHold groups
|
| GetFileholdGroupsExcluding |
Return FileHold groups excluding those with given permissions
|
| GetFilterdSessionLogs | |
| GetFilteredUserObjects | |
| GetFilteredUserObjectsByRoleType | |
| GetFilteredUserObjectsByRoleTypeCount | |
| GetFilteredUserObjectsCount |
Return number of user objects (excluding FileHold groups) matching given filter
|
| GetFilteredUsers | |
| 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 | |
| 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
|
| 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 | |
| GetSessionLogs |
Return information from the activity log
|
| GetShowNewFeatureIntroMessage |
Checks if a specific message was marked to be shown.
|
| GetStoredDomain |
Return information about specified synchronized domain
|
| GetStoredDomains |
Return domains stored in system
|
| GetSystemAuditLogs | |
| GetSystemAuditLogsByGuid | |
| GetUserObjects |
Return all user objects (including local users, domain users and domain groups), optionally matching given filter.
When all three parameters are null or empty strings, all user objects in the system are returned, including disabled users and domain groups.
In order to get all local and domain users without domain groups, use FindUserObject method instead.
The returned information includes the user GUID, names, type, enabled/disabled status, 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.
|
| GetUserObjectsCount |
Return number of user objects (excluding FileHold groups) matching given filter
|
| GetUserReportPageSize | |
| GetUsersAllowedToMakeOperations |
Return users allowed to perform specified operations
|
| GetUsersAndGroupsAllowedToMakeOperations |
Return users and groups allowed to perform specified operations
|
| 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
|
| InitializeAutomaticResetPassword |
Automatic reset password of a specified locally manager users
|
| InvokeUserAction |
Invoke a user action from plug-in
|
| IsMiddleInitialInFullNameEnabled | |
| LoadReportSetting | |
| LoadUserReportSettings | |
| MemberOfDistinctFHGroups(Guid) | |
| MemberOfDistinctFHGroups(Guid, Database, DbTransaction) | |
| RebuildCacheWebMethod | |
| ResendExternalUserEmailConfirmation(Guid) | |
| ResendExternalUserEmailConfirmation(Guid, Database, DbTransaction) | |
| ResetLocalUserPassword |
Reset password of a specified locally managed user
|
| RollbackEmailChange(String, Guid) | |
| RollbackEmailChange(String, Guid, Database, DbTransaction) | |
| SaveReportSetting | |
| SaveUserReportPageSize | |
| SetAsLicensed |
Enable FileHold license for selected users
|
| 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.
|
| SetExternalUserEnabled | |
| SetExternalUserEnabledV2 | |
| SetFileholdGroupProperties |
Modify properties of specified FileHold group
|
| SetIsRemoveLicenseFromDisabledDomainUsers |
Cofigure removing license from users disabled in domain
|
| SetLanguagePreference |
Set language for the current session
|
| SetLocalUserDetails |
Update the details of a locally managed user
|
| 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 | |
| UpdateBasicUserDetails | |
| UpdateDomain | |
| UpdateDomainFromADAM |
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertT | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
See Also