Search
K
Cipherscale API

UpdatePolicy

object

Data for updating an existing access policy

groupsarray[string]

Array of group IDs to apply this policy to

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

usersarray[string]

Array of user IDs to apply this policy to

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

devicesarray[string]

Array of device IDs to apply this policy to

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

gatewaysarray[string]

Array of gateway IDs to apply this policy to

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

resourcesarray[string]

Array of resource IDs to apply this policy to

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

rulestringrequired

Admission rule ID for this policy

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

namestringrequired

Human-readable name for the policy

Example:Engineering Team Access

descriptionstring

Detailed description of the policy’s purpose and scope

Example:Allows engineering team to access development resources

allGroupsbooleanrequired

Whether this policy applies to all groups

Default:false

allUsersbooleanrequired

Whether this policy applies to all users

Default:false

allDevicesbooleanrequired

Whether this policy applies to all devices

Default:false

allResourcesbooleanrequired

Whether this policy applies to all resources

Default:false

sourceIpsarray[string]

Array of source IP addresses or ranges

Example:192.168.1.0/24, 10.0.0.0/8

modestring

Access mode for this policy

Allowed values:LOCALRESTRICTEDREMOTE

Example:LOCAL

actionbooleanrequired

Whether this policy allows (true) or denies (false) access

Example:true

Example

GatewayStatus

string

Status of the gateway

Allowed values:ONLINEMAINTENANCENOT_REACHABLEERRORUNRECOGNIZED

TestConfiguration

object

Response from gateway configuration test

statusstringrequired

Status of the gateway

Allowed values:ONLINEMAINTENANCENOT_REACHABLEERRORUNRECOGNIZED

detailsstring

Additional details about the test result

errorstring

Standard error message from the gateway test configuration process

_errorstring

Additional error information that may be provided by the system (internal error details)

Example