Create an access control rule

Creates a new access control rule.

Path Params
string
required

A unique identifier for each access control rule.

Query Params
string
required

The Akamai contract identifier for your Enterprise Application Access product.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Properties to create and assign rules to restrict access to an application. Filters are based on username, group name, time, or other conditions.

integer
enum

The action the rule takes. Refer to Rule types & actions for more information. Use 1 for access rules.

string

ISO 8601 timestamp marking the rule's creation.

string | null
required

A description of the rule.

boolean
required

Whether to apply a rule globally. You can disable a rewrite rule for a specific content type if global application of a rule results in issues or conflicts with other rewrite rules.

boolean
required

Whether to merge with global rules. You can write custom rules that target specific content using the content type and URL or path while applying global rules to non-specified content.

string | null

ISO 8601 timestamp marking the rule's last modification.

string
required
length ≥ 1

The rule's name.

string

The unique partner ID.

string

The unique partner URI.

resource_uri
object

A plural bundle of navigable hypermedia links to other API resources.

integer
enum
required

The action the rule takes. Refer to Rule types & actions for more information. For access rules, rule type is 1.

Allowed:
string

The unique service ID.

settings
array of objects
required
length ≥ 1

Defined rule settings, such as rule type, operator, and value.

settings*
boolean

Defaults to false for access rules. Custom content types are used only for rewrite rules.

string
enum

The logical operator, either == for equals, or != for doesn't equal.

Allowed:
string
enum

The access control type. Either method, group, client_IP, user, region, country, time or url.

string

The values for the selected type.

integer
enum
required

The rule status. Either 0 for disabled or 1 for enabled.

Allowed:
string

The unique ID of the tenant.

string
length ≥ 1

The unique ID of the rule.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json