idstring(uuid)required
The unique identifier (UUID) of the admission rule to update
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
Body
application/json
Body
application/json
The admission rule data to update
UpdateAdmissionRuleDto
rulestringrequired
namestringrequired
hasTimeConstraintbooleanrequired
Response
application/json
Response
application/json
Successfully updated the admission rule
AdmissionRuleDto
idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired
Allowed values:ALLOWDENYCUSTOM
hasTimeConstraintbooleanrequired
rulestring
put/tenants/admission-rules/{id}
Authentication
Path Parameters
Body
{
"rule": "rule",
"name": "name",
"hasTimeConstraint": false
}
application/json
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
Response
application/json
Successfully retrieved the admission rule
AdmissionRuleDto
idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired
Allowed values:ALLOWDENYCUSTOM
hasTimeConstraintbooleanrequired
rulestring
get/tenants/admission-rules/{id}
Authentication
Path Parameters
application/json
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
Response
Successfully deleted the admission rule
delete/tenants/admission-rules/{id}
Authentication
Path Parameters
Policies
Network access policies and permissions
Create Access Policy
Creates a new access policy that defines which users, devices, and groups can access specific network resources. Policies are the core of the Zero Trust access control system and determine network access permissions. required: true content:
application/json:
schema:
$ref: “#/components/schemas/CreatePolicyDto”
post
https://public-api.cipherscale.com/qa/tenants/policies
Response
application/json
Response
application/json
PolicyDto
Access policy defining who can access what resources under what conditions
idstring(uuid)required
Unique identifier for the policy
createdAtstring(date-time)required
Timestamp when the policy was created
updatedAtstring(date-time)required
Timestamp when the policy was last modified
namestringrequired
Human-readable name for the policy
actionbooleanrequired
Whether this policy allows (true) or denies (false) access
ordernumberrequired
Priority order for policy evaluation (lower numbers are evaluated first)
isDefaultbooleanrequired
Whether this is a default policy that applies to all entities
typestringrequired
Type of resources this policy applies to
Allowed values:PRIVATESAASINTERNETSITETOSITE
modestring
Access mode for this policy
Allowed values:LOCALRESTRICTEDINTERNET_ACCESS_POINT
allGroupsobjectrequired
Whether this policy applies to all groups
Default:false
allUsersobjectrequired
Whether this policy applies to all users
Default:false
allDevicesobjectrequired
Whether this policy applies to all devices
Default:false
allResourcesobjectrequired
Whether this policy applies to all resources
Default:false
groupsarray[object]
Specific groups this policy applies to
Show Child Parameters
usersarray[object]
Specific users this policy applies to
Show Child Parameters
devicesarray[object]
Specific devices this policy applies to
Show Child Parameters
resourcesarray[object]
Specific resources this policy applies to
Show Child Parameters
gatewaysarray[object]
Network gateway configuration and status information
Show Child Parameters
sourceIpsarray[string]
Source IP addresses or ranges this policy applies to
ruleobjectrequired
Additional admission rules and conditions for this policy
Show Child Parameters
descriptionstring
Detailed description of the policy’s purpose and scope
post/tenants/policies
Authentication
application/json