idstring(uuid)required
The unique identifier (UUID) of the policy to update
Update Access Policy
Modifies the configuration of an existing access policy including its rules, target users/devices/resources, and access permissions. Changes take effect immediately and affect network access.
patch
https://public-api.cipherscale.com/qa/tenants/policies/{id}
Path Parameters
Body
application/json
Body
application/json
UpdatePolicyDto
groupsarray[string]
usersarray[string]
devicesarray[string]
gatewaysarray[string]
resourcesarray[string]
rulestringrequired
namestringrequired
descriptionstring
allGroupsobjectrequired
Default:false
allUsersobjectrequired
Default:false
allDevicesobjectrequired
Default:false
allResourcesobjectrequired
Default:false
sourceIpsarray[string]
modestring
Allowed values:LOCALRESTRICTEDINTERNET_ACCESS_POINT
actionbooleanrequired
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
patch/tenants/policies/{id}
Authentication
Path Parameters
Body
{
"rule": "rule",
"name": "name",
"allGroups": {},
"allUsers": {},
"allDevices": {},
"allResources": {},
"action": false
}
application/json
Get Policy Details
Retrieves comprehensive information about a specific access policy including its configuration, target entities, rules, and current status.
get
https://public-api.cipherscale.com/qa/tenants/policies/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the policy
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
get/tenants/policies/{id}
Authentication
Path Parameters
application/json
RoleDto
objectUser role definition with specific permissions and capabilities
idstring(uuid)required
Unique identifier for the role
createdAtstring(date-time)required
Timestamp when the role was created
updatedAtstring(date-time)required
Timestamp when the role was last modified
namestringrequired
Human-readable name of the role
descriptionstring
Detailed description of the role’s purpose and permissions
deleteablebooleanrequired
Whether this role can be deleted (system roles are typically not deletable)
typestringrequired
Predefined role type that determines the base permissions
Allowed values:OWNERADMINDEFAULTBASICBILLINGAUDITOR
Example
UserGroupDto
objectidstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
descriptionstring
Example
DeviceUserDto
objectidstring(uuid)required
lastConnectionstring(date-time)required
emailstring
firstNamestring
lastNamestring
Example