Zededa EnterpriseEntitlementsReport API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EnterpriseEntitlementsReport. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 8 paths,
and defines 93 schemas.
It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
9 operations8 paths93 schemas8 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
Zededa EnterpriseEntitlementsReport API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (BearerToken).
By default, every request must be authenticated.
BearerToken — Bearer token for user session
Paths & Operations 9
Across 8 paths, the API surfaces 9 operations — 8 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are DetailedUser (26 properties), Enterprise (20 properties), CrudResponseQuery (20 properties), ZsrvResponse (15 properties). Each schema is shown below with its type and property counts.
Summary
object
Summary is used to store the Summary details
3 properties
UserUsagePerEnterpriseList
object
1 property
Role
object
Role meta data
9 properties4 required
CrudStatisticsUser
object
3 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties5 required
PasswordProfile
object
10 properties
UserUsagePerEnterprise
object
2 properties
OpaqueToken64
object
1 property
Policies
object
3 properties
AppInstReport
object
Get summary reports of appInst objects for self/child enterprise
3 properties
ZksSyncStatusCode
string
AuthType
string
ProjectSummaryReport
object
2 properties
CrudContentJSON
object
1 property
FeatureEntitlement
object
3 properties
AuthProfileType
string
Scope
object
11 properties
OAUTHProfileJWTAuthProfile
object
Config for JWT based authentication, jwksuri is derived from OIDC Well Known Endpoints
1 property
AuthorizationProfile
object
Authorization profile meta data
14 properties3 required
Identifier64
object
1 property
AllowedEnterprise
object
3 properties
Credentials
object
3 properties
IdState
string
TOTPSettings
object
3 properties
RoleState
string
Values for this needs to match the const defined in libs/database/datamodel.go for backward compatibility.
CrudResultWithContent
object
3 properties
PluginSummaryReport
object
1 property
Roles
object
3 properties
EnterpriseType
string
OAUTHProfile
object
9 properties
CredentialType
string
DetailedUser
object
User meta data
26 properties3 required
PolicyScope
string
SimpleUser
object
5 properties
CrudResultCode
string
JWTAuthProfileAlgorithm
string
DeviceReport
object
Get summary reports of device objects for self/child enterprise
3 properties
ObjectType
string
ZksSyncStatus
object
2 properties
PolicyAccess
string
CrudStatisticsContainer
object
2 properties
DeviceEntitlement
object
3 properties
UserReport
object
Get summary reports of user objects for self/child enterprise
3 properties
protobufAny
object
2 properties
DocPolicies
object
3 properties
PluginReport
object
Get summary reports of plugin objects for self/child enterprise
3 properties
UserEntitlement
object
2 properties
ModelClazz
string
Credential
object
7 properties
AllowedEnterpriseList
object
Get list of child enterprises
5 properties
CrudResponseRead
object
1 property
CrudContentEncoding
string
PluginTypeEntitlement
object
3 properties
EnterpriseState
string
ZsrvError
object
3 properties
Enterprises
object
3 properties
Realm
object
Realm meta data
6 properties3 required
DeviceSummaryReport
object
2 properties
CrudResponse
object
5 properties
LastLoggedinUserInfo
object
2 properties
Entitlement
object
Get Entitlement data
6 properties
ProjectReport
object
Get summary reports of project objects for self/child enterprise
4 properties
DeviceDistribution
object
2 properties
PolicyVersionList
object
1 property
DataStream
object
2 properties
UserSummaryReport
object
3 properties
ProjectList
object
1 property
PluginEntitlement
object
3 properties
Enterprise
object
Enterprise meta data
20 properties2 required
DocPolicySummary
object
DocPolicy meta data
4 properties
ZcOpsType
string
CrudContent
object
5 properties
EnterpriseSummary
object
2 properties
Realms
object
3 properties
PolicyVersion
object
5 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
DeviceSize
string
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
Policy
object
6 properties
CrudContentProtobuf
object
12 properties
DocPolicy
object
DocPolicy meta data
7 properties1 required
DetailedUsers
object
5 properties
googlerpcStatus
object
3 properties
CrudAction
string
UserState
string
ServerSyncStatus
object
3 properties
PluginType
string
ZsrvResponse
object
15 properties
CrudResponseQuery
object
20 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
UserRole
string
AuthorizationProfiles
object
3 properties
AppInstSummaryReport
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
