GetAccessRuleResult

data class GetAccessRuleResult(val accountId: String? = null, val allowedModes: List<String>, val configuration: GetAccessRuleConfiguration, val createdOn: String, val filter: GetAccessRuleFilter? = null, val id: String, val mode: String, val modifiedOn: String, val notes: String, val ruleId: String? = null, val scope: GetAccessRuleScope, val zoneId: String? = null)

A collection of values returned by getAccessRule.

Constructors

Link copied to clipboard
constructor(accountId: String? = null, allowedModes: List<String>, configuration: GetAccessRuleConfiguration, createdOn: String, filter: GetAccessRuleFilter? = null, id: String, mode: String, modifiedOn: String, notes: String, ruleId: String? = null, scope: GetAccessRuleScope, zoneId: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accountId: String? = null

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

Link copied to clipboard

The available actions that a rule can apply to a matched request.

Link copied to clipboard

The rule configuration.

Link copied to clipboard

The timestamp of when the rule was created.

Link copied to clipboard
Link copied to clipboard
val id: String

Unique identifier for a rule.

Link copied to clipboard

The action to apply to a matched request. Available values: "block", "challenge", "whitelist", "jschallenge", "managedchallenge".

Link copied to clipboard

The timestamp of when the rule was last modified.

Link copied to clipboard

An informative summary of the rule, typically used as a reminder or explanation.

Link copied to clipboard
val ruleId: String? = null

Unique identifier for a rule.

Link copied to clipboard

All zones owned by the user will have the rule applied.

Link copied to clipboard
val zoneId: String? = null

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.