The HsvSecurityAccess object is used to get and set application security. This object provides access to security-related items such as users, roles, and security classes.
The HsvSecurityAccess object is a child of the HsvSession object. Use HsvSession’s Security property to assign HsvSecurityAccess object references as shown in the following example:
The following table lists the methods of the HsvSecurityAccess object.
Table 26. HsvSecurityAccess Object Methods
Adds or removes one or more users from the Application Administrator role. | |
Adds a security class to a Classic application. | |
AddSecurityClassWithAccessCode | For internal use. |
AllowRulesLoadForEPMAApp | For internal use. |
Deletes a security class from a Classic application. | |
DeleteSecurityClassWithAccessCode | For internal use. |
Returns arrays containing the security identifiers and usernames of the users assigned to the Application Administrator role. | |
Returns an array containing the names of an application’s roles. | |
EnumRolesForPrincipal | Returns the IDs of a user's or group's roles. |
EnumRolesForUser | Returns the localized names of a user's roles. |
Returns arrays containing an application’s security class IDs and names. | |
EnumSecurityClassRightsForPrincipal | Returns arrays representing a user's access and email alerting rights to security classes. |
Returns the access and email alerting rights that the specified users have for the specified security classes. | |
| Deprecated - use EnumUsers3. | |
EnumUsers3 | Returns arrays containing the security identifiers and usernames of an application’s users. If delegated user management is enabled in Shared Services, you can filter users who have access rights not granted to the connected user. |
Returns the security identifiers, usernames, and identity types of the users in a user group. | |
Returns the security identifiers and usernames of the users and groups assigned to a given role. | |
Returns the security identifiers and usernames of the users and groups assigned to a given role, and optionally allows you to return this information for users of any groups assigned to the role. | |
EnumUsersInSecurityClass3 | For internal use. |
Returns the security identifiers, usernames, and identity types of the users in a user group. | |
EnumUsersWithFilter | Deprecated. Use EnumUsersWithFilter2. |
EnumUsersWithFilter2 | Performs a filtered search that returns the security identifiers and usernames of matching users and groups. Filtering options include wildcard searching on usernames and filtering by user category. If delegated user management is enabled in Shared Services, you can filter users who have access rights not granted to the connected user. |
GenerateSecurityReportForBiPub | For internal use. |
GetAllSecurityClassRightsForConnectedUser | Returns arrays indicating the connected user's rights to all security classes. |
Deprecated - use GetApplicationAdministratorAccessForAllUsers2. | |
Indicates which of an application’s users are assigned to the Application Administrator role. | |
Returns the security identifier and username of the connected user. | |
Indicates whether the application’s users are assigned to a given role. | |
GetRulesMode | For internal use. |
Returns the access rights to a security class for all of an application’s users. | |
Returns the ID of a security class, given the security class’s name. | |
Returns the name of a security class, given a security class ID. | |
Indicates the access rights that the connected user has to a security class. | |
Indicates whether the connected user is allowed to perform one or more tasks. | |
Indicates whether a user is assigned to the application’s roles. | |
Returns the level of access rights that a user has for each security class in an application. | |
| Deprecated. Use GetUserInfoFromUniqueID2. | |
GetUserInfoFromUniqueID2 | Returns user information such as the username, first name, and last name, given the user's external authentication token and security identifier. |
Returns the username of a user, given the user’s security identifier (SID). | |
InsertDefaultSecurityClassWithAccessCode | For internal use. |
Indicates whether the connected user is assigned to the Application Administrator role. | |
IsClassicHFMApplication | Indicates whether an application is a Classic application. |
RenameSecurityClass | For internal use. |
Sets a user’s access and email alerting rights for one or more security classes. | |
SetRulesMode | For internal use. |
| Changes the name of a security class in a Classic application. | |
SetSecurityClassLabelWithAccessCode | For internal use. |
Sets one or more users’ access and email alerting rights to a given security class. | |
Sets a user’s access and email alerting rights for a security class. | |
Sets security class access and email alerting rights for one or more users. | |
For detailed descriptions of these methods, see HsvSecurityAccess Object Methods.