WindowsTokenRoleProvider.GetRolesForUser Method (String)
Gets a list of the Windows groups that a user is in.
Assembly: System.Web (in System.Web.dll)
Parameters
- username
-
Type:
System.String
The user to return the list of Windows groups for in the form DOMAIN\username.
Return Value
Type: System.String[]A string array containing the names of all the Windows groups that the specified user is in.
| Exception | Condition |
|---|---|
| System.Configuration.Provider.ProviderException | The currently executing user does not have an authenticated WindowsIdentity attached to Page.User. For non-HTTP scenarios, the currently executing user does not have an authenticated WindowsIdentity attached to Thread.CurrentPrincipal. -or- username does not match the Name of the current WindowsIdentity. -or- A failure occurred while retrieving the user's Windows group information. |
| ArgumentNullException | username is null. |
| HttpException | The trust level is less than Low. |
This method is called by the Roles class to retrieve from the Windows operating system a list of the Windows groups that the specified user is in. The GetRolesForUser method can be called only for the currently logged-on user, as identified by the LOGON_USER server variable. If the value supplied in the username parameter is not the name of the currently logged-on user, a System.Configuration.Provider.ProviderException is thrown.
For more information an ASP.NET and Windows authentication, see ASP.NET Authentication.
The following code example uses the GetRolesForUser method to retrieve a list of roles for a specified user and binds the list of roles to a GridView control. For an example of a Web.config file that enables role management, see WindowsTokenRoleProvider.
Available since 2.0