WindowsTokenRoleProvider.IsUserInRole メソッド

リファレンス

定義

名前空間:: System.Web.Security

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

指定したユーザーが指定した組み込みの Windows ロールに存在するかどうかを示す値を取得します。

オーバーロード

IsUserInRole(String, WindowsBuiltInRole)	指定したユーザーが指定した組み込みの Windows ロールに存在するかどうかを示す値を取得します。
IsUserInRole(String, String)	指定したユーザーが指定した Windows グループに存在するかどうかを示す値を取得します。

IsUserInRole(String, WindowsBuiltInRole)

指定したユーザーが指定した組み込みの Windows ロールに存在するかどうかを示す値を取得します。

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

パラメーター

username: String

DOMAIN\username の形式で検索するユーザー名。

role: WindowsBuiltInRole

検索範囲とする Windows ロール。

戻り値

Boolean

指定した Windows ロール内に指定したユーザーがある場合は true。それ以外の場合は false。

例外

ArgumentNullException

username が nullです。

ProviderException

現在実行しているユーザーは、WindowsIdentity に関連付けられた認証済み User を持っていません。 HTTP 以外の場合、現在実行しているユーザーは、WindowsIdentity に関連付けられた認証済み CurrentPrincipal を持っていません。

- または -

username は、現在の Name の WindowsIdentity に一致しません。

例

次のコード例では、現在ログオンしているユーザーが Administrators ロールに属しているかどうかをプログラムで確認してから、ユーザーがアプリケーションのロール情報を表示できるようにします。ロール管理を有効にする Web.config ファイルの例については、「」を参照してください 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>

注釈

IsUserInRoleメソッドを使用すると、ユーザーが列挙体でWindowsBuiltInRole記述されている一般的な Windows ロールの 1 つに含まれているかどうかを確認できます。このメソッドは、複数の言語にローカライズされたアプリケーションに役立ちます。メソッドのIsUserInRoleこのオーバーロードは基底クラスのRoleProvider一部ではなく、クラスの Roles プロパティを Provider 型としてWindowsTokenRoleProviderキャストすることによってのみアクセスできます。

メソッドは IsUserInRole 、LOGON_USER サーバー変数によって識別される、現在ログオンしているユーザーに対してのみ呼び出すことができます。パラメーターに username 指定された値が現在ログオンしているユーザーの名前ではない場合は、 HttpException がスローされます。

IsUserInRole メソッドは、LOGON_USER サーバー変数によって識別される現在ログオンしているユーザーに対してのみ呼び出すことができます。現在ログオンしているユーザーは、Windows 認証ユーザーである必要があります。 ASP.NET と Windows 認証の詳細については、「 ASP.NET 認証」を参照してください。

こちらもご覧ください

ロール管理 ASP.NET 理解する

適用対象

IsUserInRole(String, String)

指定したユーザーが指定した Windows グループに存在するかどうかを示す値を取得します。

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

パラメーター

username: String

DOMAIN\username の形式で検索するユーザー名。

roleName: String

DOMAIN\rolename の形式で検索する Windows グループ。

戻り値

Boolean

指定した Windows グループ内に指定したユーザーがある場合は true。それ以外の場合は false。

例外

ArgumentNullException

username が nullです。

または

roleName が nullです。

ProviderException

- または -

username は、現在の Name の WindowsIdentity に一致しません。

- または -

ユーザーの Windows グループ情報の取得中にエラーが発生しました。

例

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

注釈

メソッドはIsUserInRole、プロパティの Roles User クラスと IsInRole メソッドによって呼び出され、ユーザーが Windows グループに含まれているかどうかを判断します。メソッドは IsUserInRole 、LOGON_USER サーバー変数によって識別される、現在ログオンしているユーザーに対してのみ呼び出すことができます。現在ログオンしているユーザーは、Windows 認証ユーザーである必要があります。 ASP.NET と Windows 認証の詳細については、「 ASP.NET 認証」を参照してください。

こちらもご覧ください

ロール管理 ASP.NET 理解する

適用対象

次の方法で共有

WindowsTokenRoleProvider.IsUserInRole メソッド

定義

オーバーロード

IsUserInRole(String, WindowsBuiltInRole)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

IsUserInRole(String, String)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

その他のリソース