Export (0) Print
Expand All

AuthorizationRule Class

The AuthorizationRule class allows you to programmatically access and modify the authorization section of a configuration file. This class cannot be inherited.

System.Object
  System.Configuration.ConfigurationElement
    System.Web.Configuration.AuthorizationRule

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class AuthorizationRule : ConfigurationElement

The AuthorizationRule type exposes the following members.

  NameDescription
Public methodAuthorizationRuleInfrastructure. Creates a new instance of the AuthorizationRule class using the passed object.
Top

  NameDescription
Public propertyActionGets or sets the AuthorizationRule action.
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyRolesGets the roles associated with the resource.
Public propertyUsersGets the users associated with the resource.
Public propertyVerbsGets the verbs associated with the resource.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Overrides ConfigurationElement.Equals(Object).)
Public methodGetHashCodeServes as a hash function for this object. (Overrides ConfigurationElement.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The AuthorizationRule class provides a way to programmatically access and modify the authorization section of a configuration file.

This type is part of a group that includes the AuthorizationSection, the AuthorizationRuleCollection, and the AuthorizationRuleAction types.

NoteNote

The AuthorizationSection can update the configuration information at any level in the configuration hierarchy.

The following code example demonstrates how to use the AuthorizationRule.

NoteNote

If you use the credentials section, be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security capability, it is recommended that you use an external database to store users' credentials. For more information about building secure ASP.NET applications, search the Microsoft MSDN Web site (msdn.microsoft.com) for "Securing Your ASP.NET Application" and "Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication."

// Create an authorization rule object.
AuthorizationRuleAction action =
    AuthorizationRuleAction.Deny;
AuthorizationRule authorizationRule = 
    new System.Web.Configuration.AuthorizationRule(action);
// Using the AuthorizationRuleCollection Add method. 

// Set the action property.
authorizationRule.Action = 
   AuthorizationRuleAction.Allow;
// Define the new rule to add to the collection.
authorizationRule.Users.Add("userName");
authorizationRule.Roles.Add("admin");
authorizationRule.Verbs.Add("POST");

// Add the new rule to the collection.
authorizationSection.Rules.Add(authorizationRule);

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft