Creates a new user group with assigned roles and permissions. Groups provide a way to manage multiple users with similar access requirements efficiently.
The group data to create
Data required to create a new user group
Array of role IDs to assign to the group
Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]
Human-readable name for the group
Example:Marketing Team
Detailed description of the group’s purpose and scope
Example:Marketing team with access to customer data and analytics tools
Successfully created the group
Complete user group information with members, roles, and configuration
Unique identifier for the group
Example:550e8400-e29b-41d4-a716-446655440000
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
Human-readable name for the group
Example:Engineering Team
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
User role definition with specific permissions and capabilities
Whether this group can be deleted
Example:true
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"}
Maximum number of devices per user in this group
Example:5
Whether this is the default group for SAML users
Example:false
Identity provider mapping for this group
Example:["engineering@company.com"]
Retrieves a paginated list of all user groups in the tenant, including their role assignments, member counts, and configuration settings.
Successfully retrieved groups
Paginated response containing data and pagination metadata
Array of items for the current page
Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).
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].
Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.
Whether there are more pages available
Whether there are previous pages available
Modifies the configuration of an existing user group including its name, description, role assignments, and other settings.
The unique identifier (UUID) of the group to update
Data for updating group configuration
Array of role IDs to assign to the group
Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]
Human-readable name for the group
Example:Marketing Team
Detailed description of the group’s purpose and scope
Example:Marketing team with access to customer data and analytics tools
Successfully updated user group
Complete user group information with members, roles, and configuration
Unique identifier for the group
Example:550e8400-e29b-41d4-a716-446655440000
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
Human-readable name for the group
Example:Engineering Team
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
User role definition with specific permissions and capabilities
Whether this group can be deleted
Example:true
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"}
Maximum number of devices per user in this group
Example:5
Whether this is the default group for SAML users
Example:false
Identity provider mapping for this group
Example:["engineering@company.com"]
Retrieves comprehensive information about a specific user group including its members, assigned roles, permissions, and configuration settings.
The unique identifier (UUID) of the group
Successfully retrieved the group
Complete user group information with members, roles, and configuration
Unique identifier for the group
Example:550e8400-e29b-41d4-a716-446655440000
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
Human-readable name for the group
Example:Engineering Team
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
User role definition with specific permissions and capabilities
Whether this group can be deleted
Example:true
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"}
Maximum number of devices per user in this group
Example:5
Whether this is the default group for SAML users
Example:false
Identity provider mapping for this group
Example:["engineering@company.com"]
Permanently removes a user group from the tenant. This operation will also remove all group members and revoke group-based permissions.
The unique identifier (UUID) of the group to delete
Successfully deleted the group