Search
K
Cipherscale API

List All Admission Rules

Retrieves all admission rules configured for the tenant, showing the complete set of access control conditions that govern network access.

get
https://public-api.cipherscale.com/qa/tenants/admission-rules

Response

application/json

Successfully retrieved admission rules

Complete admission rule information with configuration and metadata

idstring(uuid)required

Unique identifier for the admission rule

Example:550e8400-e29b-41d4-a716-446655440000

createdAtstring(date-time)required

Timestamp when the rule was created

Example:2023-01-15T10:30:00Z

updatedAtstring(date-time)required

Timestamp when the rule was last modified

Example:2023-01-15T10:30:00Z

namestringrequired

Human-readable name for the admission rule

Example:Engineering Department Access

typestringrequired

Type of admission rule (ALLOW, DENY, or CUSTOM)

Allowed values:ALLOWDENYCUSTOM

Example:ALLOW

hasTimeConstraintbooleanrequired

Whether this rule includes time-based constraints

Example:false

rulestring

Rule logic or condition for the admission rule

Example:user.department == 'Engineering'

get/tenants/admission-rules
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/admission-rules \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering Department Access",
  "type": "ALLOW",
  "rule": "user.department == 'Engineering'",
  "hasTimeConstraint": false,
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}

Update Admission Rule

Modifies the configuration of an existing admission rule including its name, rule logic, and time constraints. Changes affect access control immediately.

put
https://public-api.cipherscale.com/qa/tenants/admission-rules/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the admission rule to update

Body

application/json

The admission rule data to update

UpdateAdmissionRule

Data for updating an admission rule

rulestringrequired

Rule logic or condition for the admission rule

Example:user.department == 'Engineering'

namestringrequired

Human-readable name for the admission rule

Example:Engineering Department Access

hasTimeConstraintbooleanrequired

Whether this rule includes time-based constraints

Example:false

Response

application/json

Successfully updated the admission rule

AdmissionRule

Complete admission rule information with configuration and metadata

idstring(uuid)required

Unique identifier for the admission rule

Example:550e8400-e29b-41d4-a716-446655440000

createdAtstring(date-time)required

Timestamp when the rule was created

Example:2023-01-15T10:30:00Z

updatedAtstring(date-time)required

Timestamp when the rule was last modified

Example:2023-01-15T10:30:00Z

namestringrequired

Human-readable name for the admission rule

Example:Engineering Department Access

typestringrequired

Type of admission rule (ALLOW, DENY, or CUSTOM)

Allowed values:ALLOWDENYCUSTOM

Example:ALLOW

hasTimeConstraintbooleanrequired

Whether this rule includes time-based constraints

Example:false

rulestring

Rule logic or condition for the admission rule

Example:user.department == 'Engineering'

put/tenants/admission-rules/{id}

Body

{
  "name": "Engineering Department Access",
  "rule": "user.department == 'Engineering'",
  "hasTimeConstraint": false
}
{ "name": "Engineering Department Access", "rule": "user.department == 'Engineering'", "hasTimeConstraint": false }
  
curl --request PUT \
  --url https://public-api.cipherscale.com/qa/tenants/admission-rules/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "name": "Engineering Department Access",
  "rule": "user.department == '\''Engineering'\''",
  "hasTimeConstraint": false
}'
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering Department Access",
  "type": "ALLOW",
  "rule": "user.department == 'Engineering'",
  "hasTimeConstraint": false,
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}

Get Admission Rule Details

Retrieves detailed information about a specific admission rule including its configuration, rule logic, time constraints, and type (ALLOW/DENY/CUSTOM).

get
https://public-api.cipherscale.com/qa/tenants/admission-rules/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the admission rule

Response

application/json

Successfully retrieved the admission rule

AdmissionRule

Complete admission rule information with configuration and metadata

idstring(uuid)required

Unique identifier for the admission rule

Example:550e8400-e29b-41d4-a716-446655440000

createdAtstring(date-time)required

Timestamp when the rule was created

Example:2023-01-15T10:30:00Z

updatedAtstring(date-time)required

Timestamp when the rule was last modified

Example:2023-01-15T10:30:00Z

namestringrequired

Human-readable name for the admission rule

Example:Engineering Department Access

typestringrequired

Type of admission rule (ALLOW, DENY, or CUSTOM)

Allowed values:ALLOWDENYCUSTOM

Example:ALLOW

hasTimeConstraintbooleanrequired

Whether this rule includes time-based constraints

Example:false

rulestring

Rule logic or condition for the admission rule

Example:user.department == 'Engineering'

get/tenants/admission-rules/{id}
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/admission-rules/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering Department Access",
  "type": "ALLOW",
  "rule": "user.department == 'Engineering'",
  "hasTimeConstraint": false,
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}

Remove Admission Rule

Permanently removes an admission rule from the tenant. This operation will affect any policies that reference this rule.

delete
https://public-api.cipherscale.com/qa/tenants/admission-rules/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the admission rule to delete

Response

Successfully deleted the admission rule

delete/tenants/admission-rules/{id}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/admission-rules/ \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
Successfully deleted the admission rule

Policies

Network access policies and permissions