idstring(uuid)required
The unique identifier (UUID) of the policy
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
Response
200 application/json
Response
200 application/json
Successfully retrieved policy details
Policy
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:LOCALRESTRICTEDREMOTE
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
groupsarray[object]
Group information within a policy context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","createdAt":"2023-01-15T14:30:00Z","updatedAt":"2023-01-15T14:30:00Z","name":"Engineering Team","description":"Team responsible for software development and engineering","maxDevices":10,"isSamlDefaultGroup":false,"idpMapping":["engineering-team","dev-team"]}
Show Child Parameters
usersarray[object]
User information within a policy context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","createdAt":"2023-01-15T14:30:00Z","updatedAt":"2023-01-15T14:30:00Z","lastConnection":"2023-01-15T14:30:00Z","email":"jane.smith@company.com","status":"ACTIVE","firstName":"Jane","lastName":"Smith","isOwner":false,"maxDevices":5,"image":"https://example.com/avatars/jane-smith.jpg"}
Show Child Parameters
devicesarray[object]
Device information within a policy context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","createdAt":"2023-01-15T14:30:00Z","updatedAt":"2023-01-15T14:30:00Z","name":"John's MacBook Pro","active":true,"lastConnection":"2023-01-15T14:30:00Z","status":"Online","hardwareId":"MAC-001122334455","posture":{"compliant":true,"lastCheck":"2023-01-15T14:30:00Z"},"appVersion":"1.2.3"}
Show Child Parameters
resourcesarray[object]
Resource information within a policy context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","createdAt":"2023-01-15T14:30:00Z","updatedAt":"2023-01-15T14:30:00Z","name":"Internal Web Server","type":"PRIVATE","loadBalancingMode":"MANUAL","description":"Internal web server for company applications"}
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
Complete admission rule information with configuration and metadata
Example:{"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"}
Show Child Parameters
descriptionstring
Detailed description of the policy’s purpose and scope
get/tenants/policies/{id}
Authentication
Path Parameters
200 application/json
Role
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:OWNERADMINDEFAULTBASICBILLINGAUDITORSUPPORT
Example
UserGroup
objectUser group information with role assignments and member management
idstring(uuid)required
Unique identifier for the user group
Example:550e8400-e29b-41d4-a716-446655440000
createdAtstring(date-time)required
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
updatedAtstring(date-time)required
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
namestringrequired
Human-readable name for the user group
Example:Engineering Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
Example
DeviceUser
objectUser information associated with a device
idstring(uuid)required
Unique identifier for the user
Example:550e8400-e29b-41d4-a716-446655440000
lastConnectionstring(date-time)required
Timestamp of the user’s last network connection
Example:2023-01-15T14:30:00Z
emailstring
User’s email address
Example:john.doe@company.com
firstNamestring
User’s first name
Example:John
lastNamestring
User’s last name
Example:Doe
Example
Device
objectDevice information including connection status, user association, and security posture
idstring(uuid)required
Unique identifier for the device
createdAtstring(date-time)required
Timestamp when the device was registered
updatedAtstring(date-time)required
Timestamp when the device information was last updated
namestringrequired
Human-readable name for the device
activebooleanrequired
Whether the device is currently active and can connect
lastConnectionstring(date-time)
Timestamp of the device’s last network connection
statusstringrequired
Current connection status of the device
Allowed values:OnlineOfflineDeactivated
userobject
Information about the user who owns this device
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","email":"john.doe@company.com","firstName":"John","lastName":"Doe","lastConnection":"2023-01-15T14:30:00Z"}
Show Child Parameters
hardwareIdstringrequired
Unique hardware identifier for the device
postureobject
Security posture information and compliance status
appVersionstring
Version of the Cipherscale client application installed on the device
Example