Zededa EnterpriseEntitlementsReport API

swagger: '2.0'
info:
  title: ZEDEDA App Profiles Service AppProfileService EnterpriseEntitlementsReport API
  description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
  termsOfService: https://www.zededa.com/terms
  version: '1.0'
  contact:
    name: ZEDEDA API Support
    url: https://www.zededa.com/support
    email: support@zededa.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EnterpriseEntitlementsReport
paths:
  /v1/entitlements:
    get:
      summary: Get entitlement data for a enterprise
      description: Get entitlement data for a enterprise
      operationId: EnterpriseEntitlementsReport_GetEnterpriseEntitlementData
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/Entitlement'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
    put:
      summary: Set entitlement data for a enterprise
      description: Set entitlement data for a enterprise.
      operationId: EnterpriseEntitlementsReport_CreateEnterpriseEntitlementData
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this entitlement record will conflict with an already entitlement record.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Entitlement'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/iam
  /v1/entitlements/allowedenterprises:
    get:
      summary: Get the list of enterprises of which the logged user can view/edit entitlements
      description: Get the list of enterprises of which the logged user can view/edit entitlements
      operationId: EnterpriseEntitlementsReport_GetAllowedEnterprisesForEntitlements
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/CrudResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: summary
        in: query
        required: false
        type: boolean
      - name: SfdcId
        in: query
        required: false
        type: string
      - name: HubspotId
        in: query
        required: false
        type: string
      - name: project
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: all
        in: query
        required: false
        type: boolean
      - name: roleName
        in: query
        required: false
        type: string
      - name: size
        in: query
        required: false
        type: string
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/allowedenterprises:
    get:
      summary: Get the list of enterprises of which the logged user can query reports
      description: Get the list of enterprises of which the logged user can query reports
      operationId: EnterpriseEntitlementsReport_GetAllowedEnterprises
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/CrudResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: summary
        in: query
        required: false
        type: boolean
      - name: SfdcId
        in: query
        required: false
        type: string
      - name: HubspotId
        in: query
        required: false
        type: string
      - name: project
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: all
        in: query
        required: false
        type: boolean
      - name: roleName
        in: query
        required: false
        type: string
      - name: size
        in: query
        required: false
        type: string
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/apps/instance:
    get:
      summary: Get appInst report
      description: Get appInst report
      operationId: EnterpriseEntitlementsReport_GetAppInstReport
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/AppInstReport'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/device:
    get:
      summary: Get device report
      description: Get device report
      operationId: EnterpriseEntitlementsReport_GetDeviceReport
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/DeviceReport'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/plugin:
    get:
      summary: Get plugin report
      description: Get plugin report
      operationId: EnterpriseEntitlementsReport_GetPluginReport
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/PluginReport'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/project:
    get:
      summary: Get project report
      description: Get project report
      operationId: EnterpriseEntitlementsReport_GetProjectReport
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ProjectReport'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
  /v1/reports/user:
    get:
      summary: Get user report
      description: Get user report
      operationId: EnterpriseEntitlementsReport_GetUserReport
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/UserReport'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: tenantId
        description: Enterprise id for which we want to get summary report for all objects
        in: query
        required: false
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EnterpriseEntitlementsReport
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/IAM
definitions:
  Summary:
    type: object
    properties:
      description:
        type: string
        description: Summary description
      total:
        type: number
        format: int64
        description: Total
      values:
        type: object
        additionalProperties:
          type: integer
          format: int64
        description: 'Values: Map for storing <string, uint32>'
    description: Summary is used to store the Summary details
    title: Summary is used to store the Summary details
  UserUsagePerEnterpriseList:
    type: object
    properties:
      userUsagePerEntp:
        type: array
        items:
          $ref: '#/definitions/UserUsagePerEnterprise'
        description: user usage per enterprise list
  Role:
    type: object
    example:
      id: AAGFABAEqnH4je5PHZTXSmHOs-XC
      name: SysRoot
      title: SysRoot
      description: ''
      revision:
        prev: ''
        curr: '1'
        createdAt: '2020-07-16T18:19:56Z'
        createdBy: SYSTEM_ROOT
        updatedAt: '1970-01-01T00:00:01Z'
        updatedBy: SYSTEM_ROOT
      type: USER_ROLE_CLUSTER
      state: ROLE_STATE_ACTIVE
      scopes:
      - accessDevice: PermissionAccessCreateReadUpdateDelete
        accessApp: PermissionAccessCreateReadUpdateDelete
        accessUser: PermissionAccessCreateReadUpdateDelete
        accessStorage: PermissionAccessCreateReadUpdateDelete
        accessEnterprise: PermissionAccessCreateReadUpdateDelete
        enterpriseFilter:
        - srAll
        projectFilter:
        - srAll
    properties:
      id:
        type: string
        description: Unique system defined role ID
        readOnly: true
        pattern: '[0-9A-Za-z_=-]{28}'
        uniqueItems: true
      name:
        type: string
        description: User defined name of the role. Name cannot be changed once created
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      title:
        type: string
        description: User defined title of the role. Title can be changed anytime
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+'
      description:
        type: string
        description: Detailed description of the role
        maxLength: 256
      revision:
        $ref: '#/definitions/ObjectRevision'
        description: System defined info
        readOnly: true
      type:
        $ref: '#/definitions/UserRole'
        description: Type of the role
      state:
        $ref: '#/definitions/RoleState'
        description: State of the role
      scopes:
        type: array
        items:
          $ref: '#/definitions/Scope'
        description: Scopes/Permissions associated with the role
      projectTags:
        type: string
        additionalProperties:
          type: string
        description: Map of project tags filter
    description: Role meta data
    title: Role detail
    required:
    - name
    - title
    - type
    - scopes
  CrudStatisticsUser:
    type: object
    properties:
      total:
        type: integer
        format: int64
      suspended:
        type: integer
        format: int64
      deleted:
        type: integer
        format: int64
    title: User related statistics
  ObjectRevision:
    type: object
    properties:
      prev:
        type: string
        description: Previous
      curr:
        type: string
        description: Current Database version of the record
      createdAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was created.
      createdBy:
        type: string
        description: 'User data: Created By'
      updatedAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was last updated.
      updatedBy:
        type: string
        description: 'User data: Updated By'
    description: ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
    title: ObjectRevision is used to store the user information.
    required:
    - curr
    - createdAt
    - createdBy
    - updatedAt
    - updatedBy
  PasswordProfile:
    type: object
    properties:
      minLength:
        type: integer
        format: int64
      maxLength:
        type: integer
        format: int64
      minNumericChars:
        type: integer
        format: int64
      minSymbolChars:
        type: integer
        format: int64
      minUppercaseChars:
        type: integer
        format: int64
      minLowercaseChars:
        type: integer
        format: int64
      maxPasswordAge:
        type: integer
        format: int64
      minPasswordAge:
        type: integer
        format: int64
      numPrevPasswordCheck:
        type: integer
        format: int64
      passwordExpiryNotificationPeriodInSeconds:
        type: integer
        format: int64
  UserUsagePerEnterprise:
    type: object
    properties:
      entpId:
        type: string
        description: Enterprise id
        readOnly: true
        pattern: '[0-9A-Za-z-]+'
      userUsage:
        type: string
        format: int64
        description: User usage for that enterprise
  OpaqueToken64:
    type: object
    properties:
      base64:
        type: string
    title: Base64 encoded opaque token
  Policies:
    type: object
    properties:
      summaryByState:
        $ref: '#/definitions/Summary'
      list:
        type: array
        items:
          $ref: '#/definitions/Policy'
      next:
        $ref: '#/definitions/Cursor'
  AppInstReport:
    type: object
    properties:
      entpId:
        type: string
        description: Enterprise id for which we want to get summary report for all objects
        pattern: '[0-9A-Za-z-]+'
        uniqueItems: true
      appInstSummaryReport:
        $ref: '#/definitions/AppInstSummaryReport'
        description: Enterprise appInst report
      error:
        type: string
        description: Error while fetching report for enterprise, if any
    description: Get summary reports of appInst objects for self/child enterprise
    title: Get appInst reports
  ZksSyncStatusCode:
    type: string
    enum:
    - ZKS_SYNC_STATUS_CODE_UNSPECIFIED
    - ZKS_SYNC_STATUS_CODE_HEALTHY
    - ZKS_SYNC_STATUS_CODE_PARTIALLY_HEALTHY
    - ZKS_SYNC_STATUS_CODE_UNHEALTHY
    default: ZKS_SYNC_STATUS_CODE_UNSPECIFIED
  AuthType:
    type: string
    enum:
    - AUTH_TYPE_UNSPECIFIED
    - AUTH_TYPE_LOCAL
    - AUTH_TYPE_OAUTH
    - AUTH_TYPE_SAML
    default: AUTH_TYPE_UNSPECIFIED
  ProjectSummaryReport:
    type: object
    properties:
      total:
        type: integer
        format: int64
      deviceDistribution:
        type: array
        items:
          $ref: '#/definitions/DeviceDistribution'
  CrudContentJSON:
    type: object
    properties:
      json:
        type: string
  FeatureEntitlement:
    type: object
    properties:
      name:
        type: string
      active:
        type: boolean
      subFeatureEntitlement:
        type: array
        items:
          $ref: '#/definitions/FeatureEntitlement'
        title: SubFeatureEntitlement represents nested sub-features entitlement
  AuthProfileType:
    type: string
    enum:
    - AUTH_PROFILE_TYPE_UNSPECIFIED
    - AUTH_PROFILE_TYPE_OAUTH_AZURE_AD
    - AUTH_PROFILE_TYPE_OAUTH_GOOGLE
    - AUTH_PROFILE_TYPE_OAUTH_CUSTOM
    - AUTH_PROFILE_TYPE_LOCAL
    default: AUTH_PROFILE_TYPE_UNSPECIFIED
  Scope:
    type: object
    properties:
      accessDevice:
        type: string
        description: Device access permission
      accessApp:
        type: string
        description: Application access permission, this will be deprecated in further release - please use accessEdgeApp and accessAppInstance for granular permission access scope.
      accessUser:
        type: string
        description: User access permission
      accessStorage:
        type: string

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-enterpriseentitlementsreport-api-openapi.yml