WindowsTokenRoleProvider.IsUserInRole Método

Referência

Definição

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém um valor que indica se o usuário especificado está na função interna do Windows especificada.

Sobrecargas

IsUserInRole(String, WindowsBuiltInRole)	Obtém um valor que indica se o usuário especificado está na função interna do Windows especificada.
IsUserInRole(String, String)	Obtém um valor que indica se o usuário especificado está no grupo do Windows especificado.

IsUserInRole(String, WindowsBuiltInRole)

Obtém um valor que indica se o usuário especificado está na função interna do Windows especificada.

public:
 bool IsUserInRole(System::String ^ username, System::Security::Principal::WindowsBuiltInRole role);

public bool IsUserInRole (string username, System.Security.Principal.WindowsBuiltInRole role);

override this.IsUserInRole : string * System.Security.Principal.WindowsBuiltInRole -> bool

Public Function IsUserInRole (username As String, role As WindowsBuiltInRole) As Boolean

Parâmetros

username: String

O nome de usuário a ser pesquisado no formato DOMAIN\username.

role: WindowsBuiltInRole

A função do Windows na qual a pesquisa será feita.

Retornos

Boolean

true se o usuário especificado estiver na função especificada do Windows, caso contrário, false.

Exceções

ArgumentNullException

username é null.

ProviderException

O usuário em execução no momento não tem uma WindowsIdentity autenticada anexada ao User. Para cenários diferentes de HTTP, o usuário em execução no momento não tem uma WindowsIdentity autenticada anexada à CurrentPrincipal.

- ou -

username não corresponde ao Name da WindowsIdentity atual.

Exemplos

O exemplo de código a seguir verifica programaticamente se o usuário conectado no momento está na função Administradores antes de permitir que o usuário exiba informações de funções para o aplicativo. Para obter um exemplo de um arquivo Web.config que habilita o gerenciamento de função, consulte WindowsTokenRoleProvider.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Security.Principal" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  Msg.Text = "";

  WindowsPrincipal p = (WindowsPrincipal)System.Threading.Thread.CurrentPrincipal;

  if (!p.IsInRole(WindowsBuiltInRole.Administrator))
  {
    Msg.Text = "You are not authorized to view user roles.";
    return;
  }


  // Bind roles to GridView.

  try
  {
    rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }

  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  Msg.Text = ""

  Dim provider As WindowsTokenRoleProvider = CType(Roles.Provider, WindowsTokenRoleProvider)

  If Not provider.IsUserInRole(User.Identity.Name, _
                               System.Security.Principal.WindowsBuiltInRole.Administrator) Then
    Msg.Text = "You are not authorized to view user roles."
    Return
  End If


  ' Bind roles to GridView.

  Try
    rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try

  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Comentários

O IsUserInRole método permite verificar se um usuário está em uma das funções comuns do Windows descritas pela WindowsBuiltInRole enumeração . Esse método é útil para aplicativos localizados em vários idiomas. Essa sobrecarga do IsUserInRole método não faz parte da RoleProvider classe base e só pode ser acessada convertendo a Provider propriedade da Roles classe como o WindowsTokenRoleProvider tipo.

Você pode chamar o IsUserInRole método somente para o usuário conectado no momento, conforme identificado pela variável de servidor LOGON_USER. Se o valor fornecido no username parâmetro não for o nome do usuário conectado no momento, um HttpException será gerado.

IsUserInRole O método só pode ser chamado para o usuário conectado no momento identificado pela variável de servidor LOGON_USER. O usuário conectado atual deve ser um usuário autenticado do Windows. Para obter mais informações sobre ASP.NET e autenticação do Windows, consulte Autenticação ASP.NET.

Confira também

Noções básicas sobre ASP.NET gerenciamento de funções

Aplica-se a

IsUserInRole(String, String)

Obtém um valor que indica se o usuário especificado está no grupo do Windows especificado.

public:
 override bool IsUserInRole(System::String ^ username, System::String ^ roleName);

public override bool IsUserInRole (string username, string roleName);

override this.IsUserInRole : string * string -> bool

Public Overrides Function IsUserInRole (username As String, roleName As String) As Boolean

Parâmetros

username: String

O nome de usuário a ser pesquisado no formato DOMAIN\username.

roleName: String

O grupo do Windows a ser pesquisado no formato DOMAIN\rolename.

Retornos

Boolean

true se o nome de usuário especificado estiver no grupo do Windows especificado, caso contrário, false.

Exceções

ArgumentNullException

username é null.

- ou -

roleName é null.

ProviderException

- ou -

username não corresponde ao Name da WindowsIdentity atual.

- ou -

Ocorreu uma falha ao recuperar as informações do grupo do Windows do usuário.

Exemplos

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  Msg.Text = "";

  try
  {
    if (!Roles.IsUserInRole(User.Identity.Name, @"BUILTIN\Administrators"))
    {
      Msg.Text = "You are not authorized to view user roles.";
      return;
    }
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }


  // Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  Msg.Text = ""

  Try
    If Not Roles.IsUserInRole(User.Identity.Name, "BUILTIN\Administrators") Then
      Msg.Text = "You are not authorized to view user roles."
      Return
    End If
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try

  ' Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Comentários

O IsUserInRole método é chamado pela Roles classe e pelo IsInRole método da User propriedade para determinar se um usuário está em um grupo do Windows. Você pode chamar o IsUserInRole método somente para o usuário conectado no momento, conforme identificado pela variável de servidor LOGON_USER. O usuário conectado atual deve ser um usuário autenticado do Windows. Para obter mais informações sobre ASP.NET e autenticação do Windows, consulte Autenticação ASP.NET.

Confira também

Noções básicas sobre ASP.NET gerenciamento de funções

Aplica-se a

Partilhar via

WindowsTokenRoleProvider.IsUserInRole Método

Definição

Sobrecargas

IsUserInRole(String, WindowsBuiltInRole)

Parâmetros

Retornos

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

IsUserInRole(String, String)

Parâmetros

Retornos

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

Recursos adicionais