Cumulocity Device Credentials API

The Device Credentials API from Cumulocity — 1 operation(s) for device credentials.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

cumulocity-device-credentials-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Device Credentials API
  version: 10.20.0
  description: 'Raise, query, acknowledge, clear, and bulk-update alarms with four severity levels (CRITICAL, MAJOR,

    MINOR, WARNING) and four statuses (ACTIVE, ACKNOWLEDGED, CLEARED). Cumulocity auto-deduplicates alarms

    by source + type so repeated raises increment the count rather than creating duplicates.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Device Credentials
paths:
  /devicecontrol/deviceCredentials:
    post:
      tags:
      - Device Credentials
      summary: Request Device Credentials
      operationId: requestDeviceCredentials
      description: Called by an unprovisioned device (authenticated as bootstrap user) to poll for credentials.
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.deviceCredentials+json:
            schema:
              $ref: '#/components/schemas/DeviceCredentialsRequest'
      responses:
        '201':
          description: Credentials issued (device registration was accepted).
          content:
            application/vnd.com.nsn.cumulocity.deviceCredentials+json:
              schema:
                $ref: '#/components/schemas/DeviceCredentials'
        '404':
          description: No accepted registration yet — device should retry.
components:
  schemas:
    DeviceCredentials:
      type: object
      properties:
        id:
          type: string
        tenantId:
          type: string
        username:
          type: string
        password:
          type: string
        self:
          type: string
          format: uri
    DeviceCredentialsRequest:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: External ID of the device.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT