Search
K
Cipherscale API

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

PaginatedResponse

Paginated response containing data and pagination metadata

dataarray

Array of items for the current page

totalinteger

Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).

pageinteger

Current page index (0-based). For offset-based pagination, page = floor(offset / limit). For page[] style, this equals the N used in page[offset] = N × page[limit].

limitinteger

Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.

hasNextboolean

Whether there are more pages available

hasPreviousboolean

Whether there are previous pages available

get/tenants/groups
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/groups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "data": [
    "[]"
  ],
  "total": 0,
  "page": 0,
  "limit": 0,
  "hasNext": false,
  "hasPrevious": false
}

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

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

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}

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"
  ]
}
{ "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" ] }
  
curl --request PUT \
  --url https://public-api.cipherscale.com/qa/tenants/groups/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering Team",
  "description": "Software engineering team with access to development resources",
  "deleteable": true,
  "maxDevices": 5,
  "isSamlDefaultGroup": false,
  "idpMapping": [
    "engineering@company.com"
  ],
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}

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

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}
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/groups/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering Team",
  "description": "Software engineering team with access to development resources",
  "deleteable": true,
  "maxDevices": 5,
  "isSamlDefaultGroup": false,
  "idpMapping": [
    "engineering@company.com"
  ],
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}

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}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/groups/ \
  --header 'Content-Type: application/json'
Successfully deleted the group

Admission Rules

Access control rules and conditions