# Cumulocity Login options API

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

Cumulocity Login options 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 Login options. 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 retrieve the login options configured in the tenant. More detailed information about the parameters and their meaning can be found in [Platform administration > Authentication](https://www.cumulocity.com/docs/authentication/basic-settings/) in the Cumulocity user documentation. > **ⓘ Info:** If OAuth external is the only login option shown in the response, the user will be automatically redirected to the SSO login screen.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/tenant/loginOptions` | Create a login option |
| GET | `/tenant/loginOptions` | Retrieve all login options |
| GET | `/tenant/loginOptions/{typeOrId}` | Retrieve a specific login option |
| PUT | `/tenant/loginOptions/{typeOrId}` | Update a specific login option |
| DELETE | `/tenant/loginOptions/{typeOrId}` | Delete a specific login option |
| POST | `/tenant/loginOptions/{typeOrId}/accessMappings` | Create a login option access mapping |
| GET | `/tenant/loginOptions/{typeOrId}/accessMappings` | Retrieve all login option access mappings |
| GET | `/tenant/loginOptions/{typeOrId}/accessMappings/{id}` | Retrieve a specific access mapping |
| PUT | `/tenant/loginOptions/{typeOrId}/accessMappings/{id}` | Update a specific access mapping |
| DELETE | `/tenant/loginOptions/{typeOrId}/accessMappings/{id}` | Delete a specific access mapping |
| POST | `/tenant/loginOptions/{typeOrId}/inventoryAccessMappings` | Create an inventory access mapping |
| GET | `/tenant/loginOptions/{typeOrId}/inventoryAccessMappings` | Retrieve all inventory access mappings |
| GET | `/tenant/loginOptions/{typeOrId}/inventoryAccessMappings/{id}` | Retrieve a specific inventory access mapping |
| PUT | `/tenant/loginOptions/{typeOrId}/inventoryAccessMappings/{id}` | Update a specific inventory access mapping |
| DELETE | `/tenant/loginOptions/{typeOrId}/inventoryAccessMappings/{id}` | Delete a specific inventory access mapping |
| PUT | `/tenant/loginOptions/{typeOrId}/restrict` | Update a tenant's access to the login option |

## Machine-readable artifacts (18)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-login-options-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

Login options

---

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