Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity User Users API

6 actions 6 updates phrasing extends openapi/cumulocity-users-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cumulocity's API. It is a proposal applied on top of the contract, not a document Cumulocity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/user/{tenantId}/users'].get

$.paths['/user/{tenantId}/users'].post

$.paths['/user/{tenantId}/users/{userId}'].get

$.paths['/user/{tenantId}/users/{userId}'].put

$.paths['/user/{tenantId}/users/{userId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity User Users API
  version: 1.0.0
extends: openapi/cumulocity-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/user/{tenantId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in a tenant
      effect: read
      questions:
      - Who are all the users in my tenant?
      - How can I see every user account for a tenant?
      instructions:
      - text: List users in tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      - text: Show all user accounts of tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user account
      effect: write
      questions:
      - How do I add a new user to my tenant?
      - Can I force a new user to reset their password on first login?
      instructions:
      - text: Create user {userName} with email {email} in tenant {tenantId}.
        slots:
          userName: requestBody.userName
          email: requestBody.email
          tenantId: path.tenantId
      - text: Add {firstName} {lastName} as a user in tenant {tenantId} in groups {groups}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          tenantId: path.tenantId
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one user
      effect: read
      questions:
      - How do I see a user's roles and groups?
      - Is two-factor authentication enabled for a particular user?
      instructions:
      - text: Show user {userId} in tenant {tenantId}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
      - text: Get the groups and roles of user {userId} in tenant {tenantId}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change another user's account
      effect: write
      questions:
      - Can I disable a user account without deleting it?
      - How do I change another user's email or groups?
      instructions:
      - text: Disable user {userId} in tenant {tenantId}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
      - text: Change the email of user {userId} in tenant {tenantId} to {email}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user account
      effect: destructive
      questions:
      - How do I remove a user who has left the company?
      - Can I permanently delete a user from a tenant?
      instructions:
      - text: Delete user {userId} from tenant {tenantId}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
      - text: Remove the account {userId} in tenant {tenantId}.
        slots:
          userId: path.userId
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'