Skip to main content
POST
Create an access rule

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

network_id
string<uuid>
required

The unique ID of the network to add the rule to.

Body

application/json
rule_type
enum<string>
required

Whether the rule includes or excludes the listed locations

Available options:
EXCLUDE_LOCATIONS,
INCLUDE_LOCATIONS
location_ids
string[]
required

UUIDs of locations the rule applies to

priority
number
required

Rule precedence; lower number = higher precedence

Required range: x >= 0
effective_from
string<date-time>

When the rule becomes active (ISO 8601). Must not be more than a minute in the past if set; defaults to now when omitted.

effective_until
string<date-time> | null

When the rule stops being active (ISO 8601). Null/omitted means open-ended.

Response

201 - application/json

The created access rule.

rule_id
string<uuid>
required

Access rule identifier.

emp_identity_id
string<uuid>
required

emp_identity the rule belongs to.

tenant_id
string<uuid>
required

Owning tenant identifier.

rule_type
enum<string>
required

Whether the rule includes or excludes.

Available options:
EXCLUDE_LOCATIONS,
INCLUDE_LOCATIONS
network_id
string<uuid>
required

Network the rule applies to.

location_ids
string<uuid>[] | null
required

Locations the rule targets; null when the rule is not location-scoped.

priority
number
required

Evaluation priority (lower wins).

effective_from
string<date>
required

Date from which the rule is effective (UTC).

effective_until
string<date> | null
required

Date the rule stops being effective (UTC); null means open-ended.

created_at
string<date-time>
required

Creation timestamp (UTC).

updated_at
string<date-time>
required

Last-update timestamp (UTC).