VGRolesInstance Class |
Manages user membership in roles for a specific VGSecurityRuntime object.
Inheritance HierarchyNamespace: Novalys.VisualGuard.Security.Membership
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
SyntaxThe VGRolesInstance type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AnonymousRole |
Gets the name of the role granted to a user during an anonymous session.
|
| AnonymousRoleId |
Gets the unique identifier of the role granted to a user during an anonymous session.
|
| ApplicationId |
Gets the Visual Guard unique identifier of the application managed by this instance.
|
| ApplicationName |
Gets the name of the application managed by this instance.
|
| DefaultRole |
Gets the name of the default role of the application.
|
| DefaultRoleId |
Gets the unique identifier of the default role of the application.
|
Methods| Name | Description | |
|---|---|---|
 | AddUsersToRole(NTAccount, String) | Obsolete. Adds the specified users to the specified role. |
| AddUsersToRole(String, String) | Obsolete. Adds the specified users to the specified role. |
| AddUsersToRole(ICollectionVGMembershipUser, VGRole) |
Grant role to users
|
| AddUsersToRole(NTAccount, String, Guid) | Obsolete. |
| AddUsersToRole(String, String, Guid) | |
| AddUsersToRoles(NTAccount, String) | Obsolete. Adds the specified users to the specified roles. |
| AddUsersToRoles(String, String) | Obsolete. Adds the specified users to the specified roles. |
| AddUsersToRoles(ICollectionVGMembershipUser, ICollectionVGRole) |
Grant role to users
|
| AddUsersToRoles(NTAccount, String, Guid) | Obsolete. |
| AddUsersToRoles(String, String, Guid) | Obsolete. |
| AddUsersToRolesById(NTAccount, Guid) | Obsolete. Adds the specified Windows accounts to the specified roles. |
| AddUsersToRolesById(String, Guid) | Obsolete. Adds a list of users specified by repository ids to the specified roles. |
| AddUsersToRolesById(NTAccount, Guid, Guid) | Obsolete. Adds the specified Windows accounts to the specified roles. |
| AddUsersToRolesById(String, Guid, Guid) | Obsolete. Adds a list of users specified by repository ids to the specified roles. |
| AddUserToRole(NTAccount, String) | Obsolete. Adds the specified user to the specified role. |
| AddUserToRole(String, String) | Obsolete. Adds the specified user to the specified role. |
| AddUserToRole(VGMembershipUser, VGRole) |
Grant role to user
|
| AddUserToRole(NTAccount, String, Guid) | Obsolete. Adds the specified user to the specified role. |
| AddUserToRole(String, String, Guid) | Obsolete. Adds the specified user to the specified role. |
| AddUserToRoleById(String, Guid) | Obsolete. Adds the user specified by the repository id to the specified role. |
| AddUserToRoleById(String, Guid, Guid) | Obsolete. Adds the user specified by the repository id to the specified role. |
| AddUserToRoles(NTAccount, String) | Obsolete. Adds the specified user to the specified roles. |
| AddUserToRoles(String, String) | Obsolete. Adds the specified user to the specified roles. |
| AddUserToRoles(VGMembershipUser, ICollectionVGRole) |
Grant roles to user
|
| AddUserToRoles(NTAccount, String, Guid) | Obsolete. Adds the specified user to the specified roles. |
| AddUserToRoles(String, String, Guid) | Obsolete. Adds the specified user to the specified roles. |
| AddUserToRolesById(String, Guid) | Obsolete. Adds a user specified by repository id to the specified roles. |
| AddUserToRolesById(String, Guid, Guid) | Obsolete. Adds a user specified by repository id to the specified roles. |
| CreateProfileAttribute(String, VGCommonProfileDataType) |
Creates profile attribute for role.
|
| CreateProfileAttribute(String, VGCommonProfileDataType, VGIProfileAttributeDefinition) |
Creates profile attribute for role.
|
| CreateProfileAttribute(String, VGCommonProfileDataType, String, String, VGIProfileAttributeDefinition) |
Creates profile attribute for role.
|
| CreateProfileAttribute(String, VGCommonProfileDataType, String, String, Boolean, Boolean, Boolean, Boolean, Int32, String, VGIProfileAttributeDefinition) |
Creates profile attribute for role.
|
| CreateProfileAttribute(String, VGCommonProfileDataType, String, String, Boolean, Boolean, Boolean, Boolean, Boolean, Int32, String, VGIProfileAttributeDefinition) |
Creates profile attribute for role.
|
| CreateProfileAttribute(String, VGCommonProfileDataType, String, String, Boolean, Boolean, Boolean, Boolean, Boolean, Int32, String, VGIProfileAttributeDefinition, Boolean) |
Creates profile attribute for role.
|
| CreateRole(String, String, VGApplication) |
Create a new role for an application
|
| CreateRole(String, String, Guid) |
Adds a new role to the repository.
|
| CreateRole(String, String, VGApplication, VGPermissionSet) |
Create a new role for an application
|
| CreateRole(String, String, Guid, Guid) |
Adds a new role to the repository.
|
| CreateSharedRole(String, String) | |
| CreateSharedRole(String, String, Guid, Guid) |
Adds a new role to the repository.
|
| DeleteProfileAttribute |
Deletes profile Attribute.
|
| DeleteRole(Guid, Boolean) | Obsolete.
Deletes a role specified by its repository id from the repository.
|
| DeleteRole(String, Boolean) | Obsolete.
Deletes a role specified by its name from the repository.
|
| DeleteRole(VGRole, Boolean) |
Deletes the role represented by the specified VGRole object from the repository.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindPermissionSetByName | Obsolete.
Gets a permission set list for the selected permission name and for the application
|
| FindRolesByName | Gets a roles for the application. |
| FindRolesByProfileAttributeValue(Guid, Object) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object) | |
| FindRolesByProfileAttributeValue(Guid, Object, Object) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object, Object) | |
| FindRolesByProfileAttributeValue(Guid, Object, Int32, Int32, Int32) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object, Int32, Int32, Int32) | |
| FindRolesByProfileAttributeValue(Guid, Object, Object, Int32, Int32, Int32) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object, Object, Int32, Int32, Int32) | |
| FindRolesByProfileAttributeValue(Guid, Object, Int32, Int32, VGSortOrderType, VGRoleSortByColumnType, Int32) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object, Int32, Int32, VGSortOrderType, VGRoleSortByColumnType, Int32) | |
| FindRolesByProfileAttributeValue(Guid, Object, Object, Int32, Int32, VGSortOrderType, VGRoleSortByColumnType, Int32) | |
| FindRolesByProfileAttributeValue(VGRoleProfileAttribute, Object, Object, Int32, Int32, VGSortOrderType, VGRoleSortByColumnType, Int32) | |
| FindSharedRolesByName | Gets a shared roles for the application. |
| FindUsersInRole(String, String) | Obsolete. Gets a list of users in a specified role where the user name contains the specified user name to match. |
| FindUsersInRole(VGRole, String) |
Find users by VGRole and Username
|
| FindUsersInRoleById | Obsolete. Gets a list of users in a specified role where the user name contains the specified user name to match. |
| GetAllPermissionSets | Obsolete. Gets a list of the permission set from the application. |
| GetAllProfileAttributes |
Gets all profile attributes for role.
|
| GetAllProfileAttributes(Int32, Int32) |
Gets all profile attributes for role.
|
| GetAllRoles | Gets a list of all the roles for the application. |
| GetAllRolesAsCollection | Gets a VGRoleCollection object representing the list of all the roles for the application. |
| GetAllRolesAsCollection(Guid) | Gets a VGRoleCollection object representing the list of all the roles for the application. |
| GetAllRolesAsCollection(VGApplication) |
Get All roles by Application
|
| GetAllRolesForUser |
Get List of VGRoles granted to the User (including the roles coming from groups)
|
| GetAllSharedRolesAsCollection | Gets a VGRoleCollection object representing the list of all the roles for the application. |
| GetAllSharedRolesAsCollection(Guid) | Gets a VGRoleCollection object representing the list of all the roles for the application. |
| GetAllSharedRolesAsCollection(VGApplication) | |
| GetAllSpecialRolesAsCollection(Guid) | Gets a VGRoleCollection object representing the list of all speciale roles for the application. |
| GetAllSpecialRolesAsCollection(VGApplication) | |
| GetAnonymousSystemRole | |
 | GetAttributes |
Get all attributes of permission contained in role
|
| GetDefaultRole(Guid) | Obsolete. |
| GetDefaultRole(VGApplication) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetMembershipRole | |
| GetPermissionSet(Guid) | Obsolete.
Gets a permission set for the application
|
| GetPermissionSet(Guid, Guid) | Obsolete.
Gets a permission set for the application
|
| GetProfileAttributeById |
Gets profile attribute by roleProfileAttributeId.
|
| GetProfileAttributeByName |
Gets profile attribute by attribute name.
|
| GetProfileAttributeDefinition |
Gets profile attribute Definition by Datatype
|
| GetRecentRoles | |
| GetRole(Guid) | Obsolete. Gets a role for the application. |
| GetRole(String) | Gets a roles for the application. |
| GetRole(Guid, Guid) | Obsolete. Gets a role for the application. |
| GetRolesByPermissionSet(VGPermissionSet) |
Gets roles to which this particular permissionset has been assigned.
This method does not contain roles of sub permissionsets.
|
| GetRolesByPermissionSet(VGPermissionSet, Boolean) |
Gets roles to which this particular permissionset has been assigned.
This method can contain roles of sub permissionset also, depending on parameter - isIncludeRolesForSubPermissionSet
|
| GetRolesForUser | Gets a list of the roles that the currently logged-on user is in. |
| GetRolesForUser(NTAccount) | Obsolete. Gets a list of the roles that a Windows account is in. |
| GetRolesForUser(String) | Gets a list of the roles that a Visual Guard user is in. |
| GetRolesForUser(VGMembershipUser) |
Get List of VGRoles granted directly to the User (excluding roles coming from groups)
|
| GetRolesForUser(String, VGAuthenticationMode) | Gets a list of the roles that a user is in. |
| GetRolesForUserById(String) | Obsolete. Gets a list of the roles that a user is in. |
| GetRolesForUserById(String, Guid) | Gets a list of the roles that a user is in. |
| GetSharedRole(Guid) | Obsolete. Gets a role for the application. |
| GetSharedRole(Guid, Guid) | Obsolete. Gets a role for the application. |
| GetSpecialRolesCollectionForUser | |
| GetSpecialRolesCollectionForUserById | Obsolete. Gets a list of speciale roles that a user is in. |
| GetSpecialRolesForUser(NTAccount) | Obsolete. Gets a list of speciales roles that a Windows account is in. |
| GetSpecialRolesForUser(String) | Obsolete. Gets a list speciales roles that a Visual Guard user is in. |
| GetSpecialRolesForUser(String, VGAuthenticationMode) | Obsolete. Gets a list of speciales roles that a user is in. |
| GetSpecialRolesForUserById | Obsolete. Gets a list of speciale roles that a user is in. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUsersInRole(Guid) | Obsolete. Gets a list of users in the specified role. |
| GetUsersInRole(String) | Gets a list of users in the specified role. |
| GetUsersInRole(VGRole) | |
| GetUsersInRole(VGRole, Int32, Int32, Int32) | |
| GetUsersInRole(VGRole, Int32, Int32, VGPrincipalSortByColumnType, VGSortOrderType, Int32) | |
| GrantPermissionToRole |
This method grants permission to role.
|
| IsUserInRole(Guid) | Gets a value indicating whether the currently logged-on user is in the specified role. |
| IsUserInRole(String) | Gets a value indicating whether the currently logged-on user is in the specified role. |
| IsUserInRole(VGRole) | |
| IsUserInRole(NTAccount, String) | Gets a value indicating whether the specified user is in the specified role. |
| IsUserInRole(String, String) | Gets a value indicating whether the specified user is in the specified role. |
| IsUserInRole(VGMembershipUser, VGRole) | |
| IsUserInRoleById | Obsolete. Gets a value indicating whether the specified user is in the specified role. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Refresh | |
| RemoveUserFromRole(NTAccount, String) | Obsolete. Removes the specified user from the specified role. |
| RemoveUserFromRole(String, String) | Obsolete. Removes the specified user from the specified role. |
| RemoveUserFromRole(VGMembershipUser, VGRole) |
Revoke role to user
|
| RemoveUserFromRole(NTAccount, String, Guid) | Obsolete. Removes the specified user from the specified role. |
| RemoveUserFromRole(String, String, Guid) | Obsolete. Removes the specified user from the specified role. |
| RemoveUserFromRoleById(String, Guid) | Obsolete. Removes a list of users specified specified by repository id from the specified role. |
| RemoveUserFromRoleById(String, Guid, Guid) | Obsolete. Removes a list of users specified specified by repository id from the specified role. |
| RemoveUserFromRoles(NTAccount, String) | Obsolete. Removes the specified user from the specified list of roles. |
| RemoveUserFromRoles(String, String) | Obsolete. Removes the specified user from the specified roles. |
| RemoveUserFromRoles(NTAccount, String, Guid) | Obsolete. Removes the specified user from the specified list of roles. |
| RemoveUserFromRoles(String, String, Guid) | Obsolete. Removes the specified user from the specified roles. |
| RemoveUserFromRolesById(String, Guid) | Obsolete. Removes the specified user from the specified roles. |
| RemoveUserFromRolesById(String, Guid, Guid) | Obsolete. Removes the specified user from the specified roles. |
| RemoveUsersFromRole(NTAccount, String) | Obsolete. Removes the specified user from the specified list of roles. |
| RemoveUsersFromRole(String, String) | Obsolete. Removes the specified users from the specified role. |
| RemoveUsersFromRole(NTAccount, String, Guid) | Obsolete. Removes the specified user from the specified list of roles. |
| RemoveUsersFromRole(String, String, Guid) | Obsolete. Removes the specified users from the specified role. |
| RemoveUsersFromRoleById(String, Guid) | Obsolete. Removes a list of users specified specified by repository id from the specified role. |
| RemoveUsersFromRoleById(String, Guid, Guid) | Obsolete. Removes a list of users specified specified by repository id from the specified role. |
| RemoveUsersFromRoles(NTAccount, String) | Obsolete. Removes the specified Windows accounts from the specified roles. |
| RemoveUsersFromRoles(String, String) | Obsolete. Removes the specified user names from the specified roles. |
| RemoveUsersFromRoles(ICollectionVGMembershipUser, ICollectionVGRole) |
Revoke roles to users
|
| RemoveUsersFromRoles(NTAccount, String, Guid) | Obsolete. Removes the specified Windows accounts from the specified roles. |
| RemoveUsersFromRoles(String, String, Guid) | Obsolete. Removes the specified user names from the specified roles. |
| RemoveUsersFromRolesById(NTAccount, Guid) | Obsolete. Removes the specified Windows accounts from the specified roles. |
| RemoveUsersFromRolesById(String, Guid) | Obsolete. Removes a list of users specified by repository ids from the specified roles. |
| RemoveUsersFromRolesById(String, String) | Obsolete. Removes the specified user names from the specified roles. |
| RemoveUsersFromRolesById(NTAccount, Guid, Guid) | Obsolete. Removes the specified Windows accounts from the specified roles. |
| RemoveUsersFromRolesById(String, Guid, Guid) | Obsolete. Removes a list of users specified by repository ids from the specified roles. |
| RemoveUsersFromRolesById(String, String, Guid) | Obsolete. Removes the specified user names from the specified roles. |
| RemoveUserToFromRoles |
Revoke roles to user
|
| RevokePermissionFromRole |
This method revokes permission from role.
|
| RoleExists(Guid) | Obsolete. |
| RoleExists(String) |
Checks whether a role exists in the current repository for the application
|
| SharedRoleExists |
Checks whether a shared role exists in the current repository
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateProfileAttribute |
Updates profile attribute for role.
|
| UpdateProfileAttributeViewOrder |
Updates profileAttribute ViewOrder
|
| UpdateRole |
Updates the repository with the information for the specified role.
|
Fields| Name | Description | |
|---|---|---|
  | DefaultInvalidCharsForRole |
Remarks
Visual Guard role management enables you to manage authorization for your application.
This class can be used to interact with VGMembership and allows to list, create and update roles
See Also