Search
K
Cipherscale API

Group

object

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

idpMappingarray[string]required

Identity provider mapping for this group

Example:engineering@company.com

Example

UpdateGroup

object

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

Example

CreateAdmissionRule

object

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

AdmissionRule

object

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

rulestring

Rule logic or condition for the admission rule

Example:user.department == 'Engineering'

Example

UpdateAdmissionRule

object

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