Try our conversational search powered by Generative AI!

AI OnAI Off

Class WindowsAdministratorsRole

Implementation of the Administrators virtual role.

Inheritance
System.Object
VirtualRoleProviderBase
WindowsAdministratorsRole
Inherited Members
Namespace: EPiServer.Security
Assembly: EPiServer.Framework.dll
Version: 8.11.0
Syntax
public class WindowsAdministratorsRole : VirtualRoleProviderBase
Remarks

This virtual role is a bit special, it is intended for Windows operating systems that have localized the name of the Administrators group. This virtual role will do a name-independent check for the Windows Administrators group. If the principal is not authenticated this role will always return false.

Constructors

WindowsAdministratorsRole()

Declaration
public WindowsAdministratorsRole()

Properties

RoleName

Gets or sets the default name of this virtual role.

Declaration
public static string RoleName { get; set; }
Property Value
Type Description
System.String
Remarks

This value is set by the initialization engine to reflect the configuration of this role.

This name may differ in different instances of this class, only use this name to get the default role name.

Methods

Initialize(String, NameValueCollection)

Initializes the localized name of the administrator role

Declaration
public override void Initialize(string name, NameValueCollection config)
Parameters
Type Name Description
System.String name

The name of the provider/role
System.Collections.Specialized.NameValueCollection config

The configuration

IsInVirtualRole(IPrincipal, Object)

Determines whether the specified principal is a member of this role.

Declaration
public override bool IsInVirtualRole(IPrincipal principal, object context)
Parameters
Type Name Description
System.Security.Principal.IPrincipal principal

The principal.
System.Object context

The context.
Returns
Type Description
System.Boolean

true if the specified principal is in the virtual role; otherwise, false.
Overrides