# Cumulocity Inventory Roles API

**Canonical:** https://apis.io/apis/cumulocity/cumulocity-inventory-roles-api/  
**Provider:** Cumulocity — https://apis.io/providers/cumulocity/  
**Base URL:** mqtt://{tenant}.cumulocity.com:1883  
**Documentation:** https://cumulocity.com/docs/device-integration/mqtt/

Cumulocity Inventory Roles API is one of 62 APIs that [Cumulocity](https://apis.io/providers/cumulocity/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 4 JSON Schema definitions. Tagged areas include Inventory Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an AsyncAPI specification, and 4 JSON Schemas.

API methods to create, retrieve, update and delete inventory roles. > **ⓘ Info:** The Accept header should be provided in all POST/PUT requests, otherwise an empty response body will be returned.

## Operations (10)

| Method | Path | Summary |
|---|---|---|
| POST | `/user/inventoryroles` | Create an inventory role |
| GET | `/user/inventoryroles` | Retrieve all inventory roles |
| GET | `/user/inventoryroles/{id}` | Retrieve a specific inventory role |
| PUT | `/user/inventoryroles/{id}` | Update a specific inventory role |
| DELETE | `/user/inventoryroles/{id}` | Remove a specific inventory role |
| POST | `/user/{tenantId}/users/{userId}/roles/inventory` | Assign an inventory role to a user |
| GET | `/user/{tenantId}/users/{userId}/roles/inventory` | Retrieve all inventory roles assigned to a user |
| GET | `/user/{tenantId}/users/{userId}/roles/inventory/{id}` | Retrieve a specific inventory role assigned to a user |
| PUT | `/user/{tenantId}/users/{userId}/roles/inventory/{id}` | Update a specific inventory role assigned to a user |
| DELETE | `/user/{tenantId}/users/{userId}/roles/inventory/{id}` | Remove a specific inventory role assigned to a user |

## Machine-readable artifacts (18)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-inventory-roles-api-openapi.yml
- **Documentation** — https://cumulocity.com/api/core/
- **Documentation** — https://cumulocity.com/docs/concepts/domain-model/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-managed-object-schema.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-ld/cumulocity-context.jsonld
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-measurement-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-event-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-alarm-schema.json
- **Documentation** — https://cumulocity.com/docs/device-integration/device-integration-introduction/
- **Documentation** — https://cumulocity.com/docs/microservice-sdk/
- **Documentation** — https://cumulocity.com/docs/reference/notifications/
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/asyncapi/cumulocity-notification2-asyncapi.yml
- **Documentation** — https://cumulocity.com/api/datahub/
- **Documentation** — https://cumulocity.com/docs/datahub/datahub-overview/
- **Documentation** — https://cumulocity.com/api/dtm/
- **Documentation** — https://cumulocity.com/docs/digital-twin-manager/dtm-overview/
- **Documentation** — https://cumulocity.com/api/edge/
- **Documentation** — https://cumulocity.com/docs/edge/edge-overview/

## Other Cumulocity APIs (12)

- [Cumulocity MQTT and SmartREST API](https://apis.io/apis/cumulocity/cumulocity-mqtt-api/)
- [Cumulocity MQTT Service API](https://apis.io/apis/cumulocity/cumulocity-mqtt-service-api/)
- [Cumulocity Alarms API](https://apis.io/apis/cumulocity/cumulocity-alarms-api/)
- [Cumulocity Application Binaries API](https://apis.io/apis/cumulocity/cumulocity-application-binaries-api/)
- [Cumulocity Applications API](https://apis.io/apis/cumulocity/cumulocity-applications-api/)
- [Cumulocity Asset Instances API](https://apis.io/apis/cumulocity/cumulocity-asset-instances-api/)
- [Cumulocity Asset Models API](https://apis.io/apis/cumulocity/cumulocity-asset-models-api/)
- [Cumulocity Binaries API](https://apis.io/apis/cumulocity/cumulocity-binaries-api/)
- [Cumulocity Bulk Operations API](https://apis.io/apis/cumulocity/cumulocity-bulk-operations-api/)
- [Cumulocity Cloud Sync API](https://apis.io/apis/cumulocity/cumulocity-cloud-sync-api/)
- [Cumulocity Current User API](https://apis.io/apis/cumulocity/cumulocity-current-user-api/)
- [Cumulocity Device Credentials API](https://apis.io/apis/cumulocity/cumulocity-device-credentials-api/)

## Tags

Inventory Roles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cumulocity/cumulocity-inventory-roles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cumulocity/.