Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: Latest
title: Cumulocity Identity API
x-logo:
url: https://www.cumulocity.com/docs/images/logo-platform.svg
backgroundColor: '#F8F8F8'
altText: Cumulocity
href: https://www.cumulocity.com/api
description: '# REST implementation
This section describes the aspects common to all REST-based interfaces of Cumulocity. The interfaces are based on the Hypertext Transfer Protocol 1.1 using HTTPS. ## HTTP usage
### Application management
Cumulocity uses a so-called "application key" to distinguish requests coming from devices and traffic from applications. If you write an application, pass the following header as part of all requests:
```markup
X-Cumulocity-Application-Key:
```
For example, if you registered your application in the Cumulocity Administration application with the key "myapp", your requests should contain the header:
```markup
X-Cumulocity-Application-Key: myapp
```
This makes your application subscribable and billable. If you implement a device, do not pass the key. > **ⓘ Info:** Make sure that you pass the key in **all** requests coming from an application. If you leave out the key,
> the request will be considered as a device request, and the corresponding device will be marked as "available". ### Limited HTTP clients
If you use an HTTP client that can only perform GET and POST methods in HTTP, you can emulate the other methods through an additional "X-HTTP-METHOD" header. Simply issue a POST request and add the header, specifying the actual REST method to be executed. For example, to emulate the "PUT" (modify) method, you can use:
```http
POST ... X-HTTP-METHOD: PUT
```
### Processing mode
Every update request (PUT, POST, DELETE) executes with a so-called *processing mode*. The processing modes are as follows:
|Processing mode|Description|
|---|---|
|PERSISTENT (default)|Stores data in the Cumulocity database and sends data to the Streaming Analytics engine. Afterwards, Cumulocity returns the result of the request. This is the default mode.|
|TRANSIENT|Sends data to the Streaming Analytics engine and immediately returns the results asynchronously but does not store data in Cumulocity’s database. This mode saves storage and processing costs and is useful for example when tracking devices in real time without requiring data to be stored.|
|QUIESCENT|Behaves similar to the persistent mode with the exception that no real-time notifications will be sent.|
|CEP|Behaves like the transient mode with the exception that no real-time notifications are sent.|
To explicitly control the processing mode of an update request, you can use the "X-Cumulocity-Processing-Mode" header with a value of either "PERSISTENT", "TRANSIENT", "QUIESCENT" or "CEP":
```markup
X-Cumulocity-Processing-Mode: PERSISTENT
```
> **ⓘ Info:** Events are always delivered to CEP/Apama for all processing modes. This is independent from real-time notifications. ### Authorization
All requests issued to Cumulocity are subject to authorization. To determine the required permissions, see the "Required role" entries for the individual requests. To learn more about the different permissions and the concept of ownership in Cumulocity, see Getting started > Technical concepts > Security aspects > Access control > Managing roles and assigning permissions in the Cumulocity user documentation. > **⚠️ Important:** In the Cumulocity API, each granular permission is identified by a unique “permission” string, which is prefixed with ROLE_ (for example, ROLE_ALARM_READ, ROLE_INVENTORY_ADMIN). Therefore, permissions are frequently referred to as “roles” throughout the API as well as in the configuration files. For example, the microservice manifest includes a requiredRoles field, which actually expects a permission string. See also the Glossary of the Cumulocity user documentation for the usage of the terms “permission” and “role” in the Cumulocity context. ### Media types
Each type of data is associated with an own media type. The general format of media types is:
```markup
application/vnd.com.nsn.cumulocity.+json;ver=;charset=UTF-8
```
Each media type contains a parameter `ver` indicating the version of the type.'
servers:
- description: Cumulocity tenant
url: https://<TENANT_DOMAIN>
security:
- Basic: []
- OAI-Secure: []
- SSO: []
- JWT-IAM: []
tags:
- name: Identity API
description: 'Cumulocity can associate devices and assets with multiple external identities.
For instance, devices can often be identified by the IMEI of their modem, by a micro-controller serial number or by an asset tag.
This is useful, for example, when you have non-functional hardware and must replace the hardware without losing the data that was recorded.
The identity API resource returns URIs and URI templates for associating external identifiers with unique identifiers.'
paths:
/identity:
get:
operationId: getIdentityApiResource
tags:
- Identity API
security:
- Basic: []
- OAI-Secure: []
- SSO: []
summary: Retrieve URIs to collections of external IDs
description: 'Retrieve URIs and URI templates for associating external identifiers with unique identifiers.
Required roles
ROLE_IDENTITY_READ'
x-code-samples:
- lang: cURL
source: 'curl --location --request GET "https://<TENANT_DOMAIN>/identity" \
--header "Authorization: Basic <AUTHORIZATION>" \
--header "Accept: application/json" \
--header "Content-Type: application/json"
'
- lang: C#
source: 'var client = new RestClient("https://<TENANT_DOMAIN>/identity");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <AUTHORIZATION>");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
'
- lang: Java
source: "Unirest.setTimeouts(0, 0);\nHttpResponse<String> response = Unirest.get(\"https://<TENANT_DOMAIN>/identity\")\n .header(\"Authorization\", \"Basic <AUTHORIZATION>\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Accept\", \"application/json\")\n .asString();\n"
- lang: Node.js
source: "var unirest = require(\"unirest\");\nvar req = unirest(\"GET\", \"https://<TENANT_DOMAIN>/identity\")\n .headers({\n \"Authorization\": \"Basic <AUTHORIZATION>\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n })\n .end(function (res) {\n if (res.error) throw new Error(res.error);\n console.log(res.raw_body);\n });\n"
- lang: Python
source: "import requests\n\nurl = \"https://<TENANT_DOMAIN>/identity\"\nheaders = {\n \"Authorization\": \"Basic <AUTHORIZATION>\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}\nresponse = requests.request(\"GET\", url, headers = headers)\nprint(response.text.encode(\"utf8\"))\n"
responses:
'200':
description: The request has succeeded and the URIs are sent in the response.
content:
application/vnd.com.nsn.cumulocity.identityapi+json:
schema:
$ref: '#/components/schemas/identityApiResource'
'401':
$ref: '#/components/responses/unauthorizedError'
'403':
$ref: '#/components/responses/operationNotAuthorized'
/identity/search:
post:
operationId: postIdentitySearch
tags:
- Identity API
security:
- Basic: []
- OAI-Secure: []
- SSO: []
summary: Lookup global identifiers matching given external identifiers
description: 'Given a list of external identifiers, returns their mapping to internal identifiers.
Required roles
ROLE_IDENTITY_READ'
x-code-samples:
- lang: cURL
source: 'curl --location --request POST "https://<TENANT_DOMAIN>/identity/search" \
--header "Authorization: Basic <AUTHORIZATION>" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data-raw ''<Payload>''
'
- lang: C#
source: 'var client = new RestClient("https://<TENANT_DOMAIN>/identity/search");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <AUTHORIZATION>");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddParameter("application/json", "<Payload>", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
'
- lang: Java
source: "Unirest.setTimeouts(0, 0);\nHttpResponse<String> response = Unirest.post(\"https://<TENANT_DOMAIN>/identity/search\")\n .header(\"Authorization\", \"Basic <AUTHORIZATION>\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Accept\", \"application/json\")\n .body(\"<Payload>\")\n .asString();\n"
- lang: Node.js
source: "var unirest = require(\"unirest\");\nvar req = unirest(\"POST\", \"https://<TENANT_DOMAIN>/identity/search\")\n .headers({\n \"Authorization\": \"Basic <AUTHORIZATION>\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n })\n .send(JSON.stringify( <Payload> ))\n .end(function (res) {\n if (res.error) throw new Error(res.error);\n console.log(res.raw_body);\n });\n"
- lang: Python
source: "import requests\nimport json\n\nurl = \"https://<TENANT_DOMAIN>/identity/search\"\nheaders = {\n \"Authorization\": \"Basic <AUTHORIZATION>\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}\nresponse = requests.request(\"POST\", url, headers = headers, data = json.dumps(<Payload>))\nprint(response.text.encode(\"utf8\"))\n"
requestBody:
required: true
content:
application/json:
example:
externalIds:
- externalId: simulator_145074_1
type: c8y_Serial
schema:
$ref: '#/components/schemas/identitySearchCriteria'
responses:
'200':
description: The request has succeeded and the external ID mappings are returned in the response.
content:
application/vnd.com.nsn.cumulocity.externalidcollection+json:
schema:
$ref: '#/components/schemas/externalIds'
'400':
$ref: '#/components/responses/invalidPayload'
'401':
$ref: '#/components/responses/unauthorizedError'
'403':
$ref: '#/components/responses/operationNotAuthorized'
components:
schemas:
identityApiResource:
type: object
properties:
externalId:
description: Single external ID, represented by the type and the value of the external ID.
type: string
format: uri
externalIdsOfGlobalId:
description: Represents a collection of external IDs for a specified global ID.
type: string
format: uri
self:
$ref: '#/components/schemas/desc_self'
example:
externalId: https://<TENANT_DOMAIN>/identity/externalIds/{type}/{externaId}
externalIdsOfGlobalId: https://<TENANT_DOMAIN>/identity/globalIds/{managedObjectId}/externalIds
self: https://<TENANT_DOMAIN>/identity
identitySearchCriteria:
type: object
required:
- externalIds
properties:
externalIds:
description: An array containing the list of external IDs to lookup.
type: array
minItems: 1
items:
$ref: '#/components/schemas/externalId'
example:
externalIds:
- externalId: simulator_145074_1
type: c8y_Serial
externalIds:
type: object
properties:
externalIds:
description: An array containing the details of all external IDs (if any).
type: array
minItems: 0
items:
$ref: '#/components/schemas/externalId'
self:
$ref: '#/components/schemas/desc_self'
example:
externalIds:
- externalId: simulator_145074_1
managedObject:
id: '251982'
self: https://<TENANT_DOMAIN>/inventory/managedObjects/251982
self: https://<TENANT_DOMAIN>/identity/externalIds/c8y_Serial/simulator_145074_1
type: c8y_Serial
self: https://<TENANT_DOMAIN>/identity/globalIds/251982/externalIds
desc_self:
title: SelfURL
description: A URL linking to this resource.
type: string
format: uri
readOnly: true
error:
type: object
properties:
error:
description: The type of error returned.
type: string
message:
description: A human-readable message providing more details about the error.
type: string
info:
description: A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the error code reported.
type: string
externalId:
type: object
required:
- externalId
- type
properties:
externalId:
description: The identifier used in the external system that Cumulocity interfaces with.
type: string
managedObject:
type: object
description: The managed object linked to the external ID.
readOnly: true
properties:
id:
$ref: '#/components/schemas/desc_objectId'
self:
$ref: '#/components/schemas/desc_self'
self:
$ref: '#/components/schemas/desc_self'
type:
description: The type of the external identifier.
type: string
example:
externalId: simulator_145074_1
managedObject:
id: '251982'
self: https://<TENANT_DOMAIN>/inventory/managedObjects/251982
self: https://<TENANT_DOMAIN>/identity/externalIds/c8y_Serial/simulator_145074_1
type: c8y_Serial
desc_objectId:
title: ObjectId
description: Unique identifier of the object.
type: string
minLength: 1
responses:
operationNotAuthorized:
description: Not authorized to perform this operation.
unauthorizedError:
description: Authentication information is missing or invalid.
content:
application/vnd.com.nsn.cumulocity.error+json:
schema:
$ref: '#/components/schemas/error'
example:
error: security/Unauthorized
message: 'Invalid credentials! : Bad credentials'
info: https://www.cumulocity.com/guides/reference-guide/#error_reporting
invalidPayload:
description: Unprocessable Entity – invalid payload.
securitySchemes:
Basic:
type: http
scheme: basic
description: 'The authorization header is formed as `Basic <Base64(<tenantID>/<c8yuser>:<password>)>`. For instance, if your tenantID, username and password are **t0071234**, **testuser** and **secret123** respectively, you can generate the Base64 string with the following command:
```shell
$ echo -n t0071234/testuser:secret123 | base64
```
and your authorization header would look like this:
```
"Authorization": "Basic dDAwNzEyMzQvdGVzdHVzZXI6c2VjcmV0MTIz"
```
'
OAI-Secure:
type: http
scheme: bearer
description: 'This is the recommended authorization method because it provides high security using authorization tokens to prove the identity of the user, and it is the default login mode on creating new tenants. This mode is an enhancement of the previous OAuth Internal authentication (available prior to 10.13.0).
For more details about OAI-Secure authentication, see [Platform administration > Authentication > Basic settings > Login settings](https://www.cumulocity.com/docs/authentication/basic-settings/#login-settings) in the Cumulocity user documentation.
'
SSO:
type: oauth2
description: "The login with SSO requires a correct configuration on the [Cumulocity side](https://www.cumulocity.com/docs/authentication/sso/). With the configuration, an additional button is available on the Login page. After clicking the button, the user is redirected to authenticate with the configured authorization server. On successful login, the user is redirected to Cumulocity.\n\nAuthentication details are exchanged using cookies. There are two parts to it, the first is the authentication cookie that is handled automatically by the Cumulocity platform. The second is the XSRF-TOKEN cookie. When a client receives the cookie, it should take the value and put it in the X-XSRF-TOKEN request header in all subsequent requests.\n\nThe flow of authenticating with authentication code grant is as follows:\n\n\n\nThe first request executed by the browser is:\n\n```http\nGET /tenant/loginOptions\nHost: https://<TENANT_DOMAIN>\nAccept: application/vnd.com.nsn.cumulocity.loginoptioncollection+json\n```\n\nResponse sample:\n\n```json\n{\n \"loginOptions\": [\n {\n \"buttonName\": \"Login with oauth\",\n \"grantType\": \"<AUTHORIZATION_CODE>\",\n \"initRequest\": \"https://<TENANT_DOMAIN>/tenant/oauth?response_type=code&tenant_id=<TENANT_ID>\",\n \"self\": \"https://<TENANT_DOMAIN>/tenant/loginOptions/oauth2\",\n \"type\": \"oauth2\"\n },\n ...\n ],\n \"self\": \"http://<TENANT_DOMAIN>/tenant/loginOptions/\"\n}\n```\n\nThe browser must invoke the request provided in the initRequest parameter.\n\nThe initRequest initiates the redirect, in which the user is prompted for credentials. After successful login, the user is redirected back to the browser, where it must capture the code request parameter. Then the request to exchange the code for the token is as follows:\n\n```http\nPOST /tenant/oauth?grant_type=authorization_code&code=<CODE>\nHost: https://<TENANT_DOMAIN>\n```\n\nA successful response will have no body but the following response headers:\n\n```\nSet-Cookie: authorization=<TOKEN>;\nSet-Cookie: XSRF-TOKEN=<XSRF-TOKEN>;\n```\n\nThe authorization cookie is valid for two weeks.\n"
flows:
clientCredentials:
tokenUrl: /tenant/oauth?grant_type=authorization_code&code=<CODE>
scopes: {}
JWT-IAM:
type: http
scheme: bearer
bearerFormat: JWT
description: 'This kind of authentication substitutes the JWT authentication with OAuth2 access tokens from your Identity and Access Management (IAM).
You can enable this in the [SSO configuration](https://www.cumulocity.com/docs/authentication/sso/).
The HTTP header must include:
```
"Authorization": "Bearer <Access token>"
```
When a request with a bearer token in the header is received, Cumulocity checks if the access token is from your IAM (that is, if authentication is enabled in your SSO configuration), and verifies the authenticity of
the token remotely against the IAM.
'
x-tagGroups:
- name: Platform
tags:
- Platform API
- name: Alarms
tags:
- Alarm API
- Alarm notification API
- Alarms
- name: Applications
tags:
- Application API
- Applications
- Application versions
- Application binaries
- Bootstrap user
- Current application
- name: Audits
tags:
- Audit API
- Audits
- name: Device control
tags:
- Device control API
- Device control notification API
- Operations
- Bulk operations
- Device credentials
- New device requests
- Device control via SMS
- name: Events
tags:
- Event API
- Event notification API
- Events
- Attachments
- name: Feature toggles
tags:
- Feature toggles API
- name: Identity
tags:
- Identity API
- External IDs
- name: Inventory
tags:
- Inventory API
- Inventory notification API
- Managed objects
- Binaries
- Child operations
- Query language
- name: Measurements
tags:
- Measurement API
- Measurement notification API
- Measurements
- Measurements specifics
- name: Notifications 2.0
tags:
- About notifications 2.0
- Notification 2.0 API
- Subscriptions
- Tokens
- name: Real-time notifications
tags:
- Real-time notification API
- name: Retentions
tags:
- Retention rules
- name: Tenants
tags:
- Tenant API
- Tenants
- Tenant applications
- Trusted certificates
- Device statistics
- Usage statistics
- Options
- Login options
- Login tokens
- System options
- name: Users
tags:
- User API
- Current User
- Users
- Groups
- Roles
- Inventory Roles
- Device Permissions
- name: Certificate
tags:
- Certificate authority
- Device enrollment
x-provenance:
method: harvested
publisher: Cumulocity
source: https://cumulocity.com/api/core/dist/c8y-oas.yml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)