WindowsTokenRoleProvider.IsUserInRole Método

Definição

Recebe um valor que indica se o utilizador especificado está no papel incorporado do Windows especificado.

Sobrecargas

Name Description
IsUserInRole(String, WindowsBuiltInRole)

Recebe um valor que indica se o utilizador especificado está no papel incorporado do Windows especificado.

IsUserInRole(String, String)

Recebe um valor que indica se o utilizador especificado está no grupo Windows especificado.

IsUserInRole(String, WindowsBuiltInRole)

Recebe um valor que indica se o utilizador especificado está no papel incorporado do Windows especificado.

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 utilizador a procurar na forma DOMÍNIO\nome de utilizador.

role
WindowsBuiltInRole

O papel do Windows para pesquisar.

Devoluções

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

Exceções

username é null.

O utilizador que está a executar atualmente não tem um autenticado WindowsIdentity associado a User. Para cenários não-HTTP, o utilizador que está a executar atualmente não tem um autenticado WindowsIdentity associado a CurrentPrincipal.

-ou-

username não corresponde à Name da corrente WindowsIdentity.

Exemplos

O exemplo de código seguinte verifica programaticamente se o utilizador atualmente ligado está no papel de Administrador antes de permitir que o utilizador veja a informação dos papéis da aplicação. Para um exemplo de um ficheiro Web.config que permite a gestão de funções, veja 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>

Observações

O método IsUserInRole permite-lhe verificar se um utilizador está num dos papéis comuns de Windows descritos pela enumeração WindowsBuiltInRole. Este método é útil para aplicações localizadas em várias línguas. Esta sobrecarga do IsUserInRole método não faz parte da RoleProvider classe base e só pode ser acedida castando a Provider propriedade da Roles classe como o WindowsTokenRoleProvider tipo.

Pode chamar o IsUserInRole método apenas para o utilizador atualmente ligado, conforme identificado pela variável do servidor LOGON_USER. Se o valor fornecido no username parâmetro não for o nome do utilizador atualmente ligado, um HttpException é lançado.

IsUserInRole O método só pode ser chamado para o utilizador atualmente ligado identificado pela variável LOGON_USER servidor. O utilizador atualmente iniciado deve ser um utilizador autenticado pelo Windows. Para mais informações sobre ASP.NET e Windows authentication, consulte ASP.NET Autenticação.

Ver também

Aplica-se a

IsUserInRole(String, String)

Recebe um valor que indica se o utilizador especificado está no grupo 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 utilizador a procurar na forma DOMÍNIO\nome de utilizador.

roleName
String

O grupo Windows a pesquisar na forma DOMAIN\rolename.

Devoluções

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

Exceções

username é null.

-ou-

roleName é null.

O utilizador que está a executar atualmente não tem um autenticado WindowsIdentity associado a User. Para cenários não-HTTP, o utilizador que está a executar atualmente não tem um autenticado WindowsIdentity associado a CurrentPrincipal.

-ou-

username não corresponde à Name da corrente WindowsIdentity.

-ou-

Ocorreu uma falha ao recuperar a informação do grupo Windows do utilizador.

Exemplos

O exemplo de código seguinte verifica programaticamente se o utilizador atualmente ligado está no papel de Administrador antes de permitir que o utilizador veja a informação dos papéis da aplicação. Para um exemplo de um ficheiro Web.config que permite a gestão de funções, veja WindowsTokenRoleProvider.

<%@ 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>

Observações

O método IsUserInRole é chamado pela classe Roles e pelo método IsInRole da propriedade User para determinar se um utilizador pertence a um grupo Windows. Pode chamar o IsUserInRole método apenas para o utilizador atualmente ligado, conforme identificado pela variável do servidor LOGON_USER. O utilizador atualmente ligado deve ser um utilizador autenticado pelo Windows. Para mais informações sobre ASP.NET e Windows authentication, consulte ASP.NET Autenticação.

Ver também

Aplica-se a