Class AccessRule
A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request.
Inherited Members
Namespace: Oci.WaasService.Models
Assembly: OCI.DotNetSDK.Waas.dll
Syntax
public class AccessRule
Properties
Action
Declaration
[Required(ErrorMessage = "Action is required.")]
[JsonProperty(PropertyName = "action")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AccessRule.ActionEnum? Action { get; set; }
Property Value
Type | Description |
---|---|
AccessRule.ActionEnum? | The action to take when the access criteria are met for a rule. If unspecified, defaults to
|
Remarks
Required
BlockAction
Declaration
[JsonProperty(PropertyName = "blockAction")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AccessRule.BlockActionEnum? BlockAction { get; set; }
Property Value
Type | Description |
---|---|
AccessRule.BlockActionEnum? | The method used to block requests if |
BlockErrorPageCode
Declaration
[JsonProperty(PropertyName = "blockErrorPageCode")]
public string BlockErrorPageCode { get; set; }
Property Value
Type | Description |
---|---|
string | The error code to show on the error page when |
BlockErrorPageDescription
Declaration
[JsonProperty(PropertyName = "blockErrorPageDescription")]
public string BlockErrorPageDescription { get; set; }
Property Value
Type | Description |
---|---|
string | The description text to show on the error page when |
BlockErrorPageMessage
Declaration
[JsonProperty(PropertyName = "blockErrorPageMessage")]
public string BlockErrorPageMessage { get; set; }
Property Value
Type | Description |
---|---|
string | The message to show on the error page when |
BlockResponseCode
Declaration
[JsonProperty(PropertyName = "blockResponseCode")]
public int? BlockResponseCode { get; set; }
Property Value
Type | Description |
---|---|
int? | The response status code to return when |
BypassChallenges
Declaration
[JsonProperty(PropertyName = "bypassChallenges", ItemConverterType = typeof(ResponseEnumConverter))]
public List<AccessRule.BypassChallengesEnum> BypassChallenges { get; set; }
Property Value
Type | Description |
---|---|
List<AccessRule.BypassChallengesEnum> | The list of challenges to bypass when
|
CaptchaFooter
Declaration
[JsonProperty(PropertyName = "captchaFooter")]
public string CaptchaFooter { get; set; }
Property Value
Type | Description |
---|---|
string | The text to show in the footer when showing a CAPTCHA challenge when |
CaptchaHeader
Declaration
[JsonProperty(PropertyName = "captchaHeader")]
public string CaptchaHeader { get; set; }
Property Value
Type | Description |
---|---|
string | The text to show in the header when showing a CAPTCHA challenge when |
CaptchaSubmitLabel
Declaration
[JsonProperty(PropertyName = "captchaSubmitLabel")]
public string CaptchaSubmitLabel { get; set; }
Property Value
Type | Description |
---|---|
string | The text to show on the label of the CAPTCHA challenge submit button when |
CaptchaTitle
Declaration
[JsonProperty(PropertyName = "captchaTitle")]
public string CaptchaTitle { get; set; }
Property Value
Type | Description |
---|---|
string | The title used when showing a CAPTCHA challenge when |
Criteria
Declaration
[Required(ErrorMessage = "Criteria is required.")]
[JsonProperty(PropertyName = "criteria")]
public List<AccessRuleCriteria> Criteria { get; set; }
Property Value
Type | Description |
---|---|
List<AccessRuleCriteria> | The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions. |
Remarks
Required
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The unique name of the access rule. |
Remarks
Required
RedirectResponseCode
Declaration
[JsonProperty(PropertyName = "redirectResponseCode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AccessRule.RedirectResponseCodeEnum? RedirectResponseCode { get; set; }
Property Value
Type | Description |
---|---|
AccessRule.RedirectResponseCodeEnum? | The response status code to return when
|
RedirectUrl
Declaration
[JsonProperty(PropertyName = "redirectUrl")]
public string RedirectUrl { get; set; }
Property Value
Type | Description |
---|---|
string | The target to which the request should be redirected, represented as a URI reference. Required when |
ResponseHeaderManipulation
Declaration
[JsonProperty(PropertyName = "responseHeaderManipulation")]
public List<HeaderManipulationAction> ResponseHeaderManipulation { get; set; }
Property Value
Type | Description |
---|---|
List<HeaderManipulationAction> | An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of |