Cumulocity Users API

The Users API from Cumulocity — 2 operation(s) for users.

Documentation GitHub OpenAPI

Business capability

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}/users List users in a tenant · List Users #

Ask an LLM

“Who are all the users in my tenant?”

“How can I see every user account for a tenant?”

Tell an agent

List users in tenant {tenantId}.

Show all user accounts of tenant {tenantId}.

POST /user/{tenantId}/users Create a user account · Create a User #

Ask an LLM

“How do I add a new user to my tenant?”

“Can I force a new user to reset their password on first login?”

Tell an agent

Create user {userName} with email {email} in tenant {tenantId}.

Add {firstName} {lastName} as a user in tenant {tenantId} in groups {groups}.

GET /user/{tenantId}/users/{userId} Look up one user · Retrieve a User #

Ask an LLM

“How do I see a user's roles and groups?”

“Is two-factor authentication enabled for a particular user?”

Tell an agent

Show user {userId} in tenant {tenantId}.

Get the groups and roles of user {userId} in tenant {tenantId}.

PUT /user/{tenantId}/users/{userId} Change another user's account · Update a User #

Ask an LLM

“Can I disable a user account without deleting it?”

“How do I change another user's email or groups?”

Tell an agent

Disable user {userId} in tenant {tenantId}.

Change the email of user {userId} in tenant {tenantId} to {email}.

DELETE /user/{tenantId}/users/{userId} Delete a user account · Delete a User #

Ask an LLM

“How do I remove a user who has left the company?”

“Can I permanently delete a user from a tenant?”

Tell an agent destructive · confirm first

Delete user {userId} from tenant {tenantId}.

Remove the account {userId} in tenant {tenantId}.

Work with this as data

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-users-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 Users 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: Users
paths:
  /user/{tenantId}/users:
    parameters:
    - name: tenantId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Users
      summary: List Users
      operationId: listUsers
      responses:
        '200':
          description: A collection of users.
          content:
            application/vnd.com.nsn.cumulocity.userCollection+json:
              schema:
                $ref: '#/components/schemas/UserCollection'
    post:
      tags:
      - Users
      summary: Create a User
      operationId: createUser
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.user+json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: User created.
  /user/{tenantId}/users/{userId}:
    parameters:
    - name: tenantId
      in: path
      required: true
      schema:
        type: string
    - name: userId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Users
      summary: Retrieve a User
      operationId: getUser
      responses:
        '200':
          description: A single user.
          content:
            application/vnd.com.nsn.cumulocity.user+json:
              schema:
                $ref: '#/components/schemas/User'
    put:
      tags:
      - Users
      summary: Update a User
      operationId: updateUser
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.user+json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: User updated.
    delete:
      tags:
      - Users
      summary: Delete a User
      operationId: deleteUser
      responses:
        '204':
          description: User deleted.
components:
  schemas:
    UserCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
    User:
      type: object
      properties:
        id:
          type: string
        self:
          type: string
          format: uri
        userName:
          type: string
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        displayName:
          type: string
        phone:
          type: string
        enabled:
          type: boolean
        password:
          type: string
          writeOnly: true
        shouldResetPassword:
          type: boolean
        lastPasswordChange:
          type: string
          format: date-time
        twoFactorAuthenticationEnabled:
          type: boolean
        groups:
          type: object
          properties:
            references:
              type: array
              items:
                type: object
        roles:
          type: object
          properties:
            references:
              type: array
              items:
                type: object
        devicePermissions:
          type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity Users 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