Cumulocity Groups API

The Groups API from Cumulocity — 2 operation(s) for groups.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /user/{tenantId}/groups List user groups in a tenant · List Groups #

Ask an LLM

“Which user groups exist in my tenant?”

“What permission groups can I assign users to?”

Tell an agent

List the user groups in tenant {tenantId}.

Show all groups defined for tenant {tenantId}.

POST /user/{tenantId}/groups Create a user group · Create a Group #

Ask an LLM

“How do I create a new user group with its own roles?”

“Can I add users and roles to a group at the moment I create it?”

Tell an agent

Create group {name} in tenant {tenantId}.

Create group {name} in tenant {tenantId} with roles {roles}.

GET /user/{tenantId}/groups/{groupId} Look up one user group · Retrieve a Group #

Ask an LLM

“How do I see which roles and users belong to one group?”

“What does a specific user group grant?”

Tell an agent

Show group {groupId} in tenant {tenantId}.

Get the roles and members of group {groupId} in tenant {tenantId}.

PUT /user/{tenantId}/groups/{groupId} Change a user group · Update a Group #

Ask an LLM

“Can I rename a user group or change its description?”

“How do I change the roles assigned to an existing group?”

Tell an agent

Rename group {groupId} in tenant {tenantId} to {name}.

Set the roles of group {groupId} in tenant {tenantId} to {roles}.

DELETE /user/{tenantId}/groups/{groupId} Delete a user group · Delete a Group #

Ask an LLM

“How do I delete a user group that is no longer used?”

“Can I remove a permission group from a tenant?”

Tell an agent destructive · confirm first

Delete group {groupId} from tenant {tenantId}.

Remove user group {groupId} in tenant {tenantId}.

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cumulocity:cumulocity-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cumulocity User Groups API
  version: 10.20.0
  description: 'Manage users, user groups, global roles, inventory roles, and device permissions. Cumulocity uses an

    RBAC model where global roles grant API access and inventory roles grant access to specific managed-object

    subtrees. Supports SSO via SAML/OIDC and SCIM provisioning for enterprise tenants.'
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Groups
paths:
  /user/{tenantId}/groups:
    parameters:
    - name: tenantId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Groups
      summary: List Groups
      operationId: listGroups
      responses:
        '200':
          description: A collection of groups.
    post:
      tags:
      - Groups
      summary: Create a Group
      operationId: createGroup
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.group+json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        '201':
          description: Group created.
  /user/{tenantId}/groups/{groupId}:
    parameters:
    - name: tenantId
      in: path
      required: true
      schema:
        type: string
    - name: groupId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Groups
      summary: Retrieve a Group
      operationId: getGroup
      responses:
        '200':
          description: A single group.
    put:
      tags:
      - Groups
      summary: Update a Group
      operationId: updateGroup
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.group+json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        '200':
          description: Group updated.
    delete:
      tags:
      - Groups
      summary: Delete a Group
      operationId: deleteGroup
      responses:
        '204':
          description: Group deleted.
components:
  schemas:
    Group:
      type: object
      properties:
        id:
          type: integer
        self:
          type: string
          format: uri
        name:
          type: string
        description:
          type: string
        roles:
          type: object
        users:
          type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity Groups API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification