Search
K
Cipherscale API

Create User Group

Creates a new user group with assigned roles and permissions. Groups provide a way to manage multiple users with similar access requirements efficiently.

post
https://public-api.cipherscale.com/qa/tenants/groups

Body

application/json

The group data to create

CreateGroupDto

rolesarray[string]required
namestringrequired
descriptionstring

Response

application/json

Successfully created the group

GroupDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
descriptionstring
rolesarray[object]required

User role definition with specific permissions and capabilities

Show Child Parameters
deleteablebooleanrequired
usersarray[object]required
Show Child Parameters
maxDevicesnumberrequired
isSamlDefaultGroupbooleanrequired
idpMappingarray[string]required
post/tenants/groups

Body

{ "roles": [ "[]" ], "name": "name" }
 
application/json

List All User Groups

Retrieves a paginated list of all user groups in the tenant, including their role assignments, member counts, and configuration settings.

get
https://public-api.cipherscale.com/qa/tenants/groups

Query Parameters

sortarray[string]
limitnumber
offsetnumber

Response

application/json

Successfully retrieved groups

PaginatedDto

PaginatedDtoobject
get/tenants/groups
 
application/json

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

idstring(uuid)required

The unique identifier (UUID) of the group to update

Body

application/json

UpdateGroupDto

rolesarray[string]required
namestringrequired
descriptionstring

Response

application/json

GroupDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
descriptionstring
rolesarray[object]required

User role definition with specific permissions and capabilities

Show Child Parameters
deleteablebooleanrequired
usersarray[object]required
Show Child Parameters
maxDevicesnumberrequired
isSamlDefaultGroupbooleanrequired
idpMappingarray[string]required
put/tenants/groups/{id}

Body

{ "roles": [ "[]" ], "name": "name" }
 
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

Successfully retrieved the group

GroupDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
descriptionstring
rolesarray[object]required

User role definition with specific permissions and capabilities

Show Child Parameters
deleteablebooleanrequired
usersarray[object]required
Show Child Parameters
maxDevicesnumberrequired
isSamlDefaultGroupbooleanrequired
idpMappingarray[string]required
get/tenants/groups/{id}
 
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

Successfully deleted the group

delete/tenants/groups/{id}