Search
K
Cipherscale API

PolicyResourceDto

object
idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

loadBalancingModestringrequired

Allowed values:MANUALAUTOMATIC

Default:MANUAL

descriptionstring
Example

PolicyDto

object

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

Example

UpdatePolicyDto

object
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
Example