idstring(uuid)required
The unique identifier (UUID) of the group to delete
Remove User Group
Permanently removes a user group from the tenant. This operation will also remove all group members and revoke group-based permissions.
delete
https://public-api.cipherscale.com/qa/tenants/groups/{id}
Path Parameters
Response
Response
Successfully deleted the group
delete/tenants/groups/{id}
Authentication
Path Parameters
Admission Rules
Access control rules and conditions
Create Admission Rule
Creates a new admission rule that defines conditions for allowing or denying access to network resources. Admission rules can include time constraints and custom logic for fine-grained access control.
post
https://public-api.cipherscale.com/qa/tenants/admission-rules
Body
application/json
Body
application/json
The admission rule data to create
CreateAdmissionRule
Data required to create a new admission rule
rulestringrequired
Rule logic or condition for the admission rule
Example:user.department == 'Engineering'
namestringrequired
Human-readable name for the admission rule
Example:Engineering Department Access
hasTimeConstraintbooleanrequired
Whether this rule includes time-based constraints
Example:false
Response
application/json
Response
application/json
Successfully created the admission rule
AdmissionRule
Complete admission rule information with configuration and metadata
idstring(uuid)required
Unique identifier for the admission rule
Example:550e8400-e29b-41d4-a716-446655440000
createdAtstring(date-time)required
Timestamp when the rule was created
Example:2023-01-15T10:30:00Z
updatedAtstring(date-time)required
Timestamp when the rule was last modified
Example:2023-01-15T10:30:00Z
namestringrequired
Human-readable name for the admission rule
Example:Engineering Department Access
typestringrequired
Type of admission rule (ALLOW, DENY, or CUSTOM)
Allowed values:ALLOWDENYCUSTOM
Example:ALLOW
hasTimeConstraintbooleanrequired
Whether this rule includes time-based constraints
Example:false
rulestring
Rule logic or condition for the admission rule
Example:user.department == 'Engineering'
post/tenants/admission-rules
Authentication
Body
{
"name": "Engineering Department Access",
"rule": "user.department == 'Engineering'",
"hasTimeConstraint": false
}
application/json
List All Admission Rules
Retrieves all admission rules configured for the tenant, showing the complete set of access control conditions that govern network access.
get
https://public-api.cipherscale.com/qa/tenants/admission-rules
Response
application/json
Response
application/json
Successfully retrieved admission rules
Complete admission rule information with configuration and metadata
idstring(uuid)required
Unique identifier for the admission rule
Example:550e8400-e29b-41d4-a716-446655440000
createdAtstring(date-time)required
Timestamp when the rule was created
Example:2023-01-15T10:30:00Z
updatedAtstring(date-time)required
Timestamp when the rule was last modified
Example:2023-01-15T10:30:00Z
namestringrequired
Human-readable name for the admission rule
Example:Engineering Department Access
typestringrequired
Type of admission rule (ALLOW, DENY, or CUSTOM)
Allowed values:ALLOWDENYCUSTOM
Example:ALLOW
hasTimeConstraintbooleanrequired
Whether this rule includes time-based constraints
Example:false
rulestring
Rule logic or condition for the admission rule
Example:user.department == 'Engineering'
get/tenants/admission-rules
Authentication
application/json
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
idstring(uuid)required
The unique identifier (UUID) of the admission rule to update
Body
application/json
Body
application/json
The admission rule data to update
UpdateAdmissionRule
Data for updating an admission rule
rulestringrequired
Rule logic or condition for the admission rule
Example:user.department == 'Engineering'
namestringrequired
Human-readable name for the admission rule
Example:Engineering Department Access
hasTimeConstraintbooleanrequired
Whether this rule includes time-based constraints
Example:false
Response
application/json
Response
application/json
Successfully updated the admission rule
AdmissionRule
Complete admission rule information with configuration and metadata
idstring(uuid)required
Unique identifier for the admission rule
Example:550e8400-e29b-41d4-a716-446655440000
createdAtstring(date-time)required
Timestamp when the rule was created
Example:2023-01-15T10:30:00Z
updatedAtstring(date-time)required
Timestamp when the rule was last modified
Example:2023-01-15T10:30:00Z
namestringrequired
Human-readable name for the admission rule
Example:Engineering Department Access
typestringrequired
Type of admission rule (ALLOW, DENY, or CUSTOM)
Allowed values:ALLOWDENYCUSTOM
Example:ALLOW
hasTimeConstraintbooleanrequired
Whether this rule includes time-based constraints
Example:false
rulestring
Rule logic or condition for the admission rule
Example:user.department == 'Engineering'
put/tenants/admission-rules/{id}
Authentication
Path Parameters
Body
{
"name": "Engineering Department Access",
"rule": "user.department == 'Engineering'",
"hasTimeConstraint": false
}
application/json