API
This section provides an overview of the APIs available in Omada Identity Cloud Private.
This documentation applies to both Omada Identity Cloud Private and Omada Identity Cloud. If there are any Cloud Private-specific differences, they will be listed below or highlighted in note boxes throughout the documentation.
For general API documentation, go to the API section of the Omada Identity Cloud documentation.
Omada Identity Cloud Private: API differences
Endpoints and fields
In Omada Identity Cloud Private, the API endpoints and fields are the same as in Omada Identity Cloud. However, there may be differences in the data returned by the API due to the on-premises nature of Omada Identity Cloud Private.
Configuration REST API endpoints
Omada Identity Cloud Private exposes Configuration REST API endpoints (such as /api/Configuration/HistoryTracking, /api/Configuration/Persistence, /api/Configuration/EnterpriseServer, and others) that provide programmatic access to system configuration. These endpoints are not formally documented in the main API reference but are publicly available and can be discovered in the Swagger/OpenAPI documentation available in your Omada Identity Cloud Private instance.
Delivery zone field behavior
Some Configuration endpoints include a deliveryZone field in their responses. In Omada Identity Cloud Private (single-tenant deployment), this field returns null. This is expected behavior and not an error or misconfiguration. The deliveryZone concept applies only to multi-tenant Omada Identity Cloud deployments. If you receive a null value for this field, no action is required.