idstring(uuid)required
The unique identifier (UUID) of the group to update
Update User Group
Modifies the configuration of an existing user group including its name, description, role assignments, and other settings.
put
https://public-api.cipherscale.com/qa/tenants/groups/{id}
Path Parameters
Body
application/json
Body
application/json
UpdateGroup
Data for updating group configuration
rolesarray[string]required
Array of role IDs to assign to the group
Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]
namestringrequired
Human-readable name for the group
Example:Marketing Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Marketing team with access to customer data and analytics tools
Response
200 application/json
Response
200 application/json
Successfully updated user group
Group
Complete user group information with members, roles, and configuration
idstring(uuid)required
Unique identifier for the 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 group
Example:Engineering Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
rolesarray[object]required
User role definition with specific permissions and capabilities
Show Child Parameters
deleteablebooleanrequired
Whether this group can be deleted
Example:true
usersarray[object]required
User information within a group context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","firstName":"John","lastName":"Doe","email":"john.doe@company.com","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}
Show Child Parameters
maxDevicesnumberrequired
Maximum number of devices per user in this group
Example:5
isSamlDefaultGroupbooleanrequired
Whether this is the default group for SAML users
Example:false
idpMappingarray[string]required
Identity provider mapping for this group
Example:["engineering@company.com"]
put/tenants/groups/{id}
Authentication
Path Parameters
Body
{
"name": "Marketing Team",
"description": "Marketing team with access to customer data and analytics tools",
"roles": [
"550e8400-e29b-41d4-a716-446655440000",
"550e8400-e29b-41d4-a716-446655440001"
]
}
200 application/json
Get Group Details
Retrieves comprehensive information about a specific user group including its members, assigned roles, permissions, and configuration settings.
get
https://public-api.cipherscale.com/qa/tenants/groups/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the group
Response
application/json
Response
application/json
Successfully retrieved the group
Group
Complete user group information with members, roles, and configuration
idstring(uuid)required
Unique identifier for the 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 group
Example:Engineering Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
rolesarray[object]required
User role definition with specific permissions and capabilities
Show Child Parameters
deleteablebooleanrequired
Whether this group can be deleted
Example:true
usersarray[object]required
User information within a group context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","firstName":"John","lastName":"Doe","email":"john.doe@company.com","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}
Show Child Parameters
maxDevicesnumberrequired
Maximum number of devices per user in this group
Example:5
isSamlDefaultGroupbooleanrequired
Whether this is the default group for SAML users
Example:false
idpMappingarray[string]required
Identity provider mapping for this group
Example:["engineering@company.com"]
get/tenants/groups/{id}
Authentication
Path Parameters
application/json
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
idstring(uuid)required
The unique identifier (UUID) of the group to delete
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