edge-api/source/shared/identities.yml

---

definitions:
  identityList:
    description: A list of identities
    type: array
    items:
      $ref: '#/definitions/identityDetail'
  identityDetail:
    description: Detail of a specific identity
    type: object
    allOf:
      - $ref: 'base-entity.yml#/definitions/baseEntity'
      - type: object
        required:
          - name
          - type
          - typeId
          - isDefaultAdmin
          - isAdmin
          - authenticators
          - enrollment
          - envInfo
          - sdkInfo
          - roleAttributes
          - hasEdgeRouterConnection
          - edgeRouterConnectionStatus
          - hasApiSession
          - isMfaEnabled
          - serviceHostingPrecedences
          - serviceHostingCosts
          - defaultHostingCost
          - authPolicyId
          - authPolicy
          - externalId
          - disabled
          - permissions
        properties:
          name:
            type: string
          type:
            $ref: 'base-entity.yml#/definitions/entityRef'
          typeId:
            type: string
          isDefaultAdmin:
            type: boolean
          isAdmin:
            type: boolean
          authenticators:
            $ref: '#/definitions/identityAuthenticators'
          enrollment:
            $ref: '#/definitions/identityEnrollments'
          envInfo:
            $ref: 'authenticate.yml#/definitions/envInfo'
          sdkInfo:
            $ref: 'authenticate.yml#/definitions/sdkInfo'
          roleAttributes:
            $ref: 'base-entity.yml#/definitions/attributes'
          hasEdgeRouterConnection:
            type: boolean
          edgeRouterConnectionStatus:
            type: string
            enum:
              - online
              - offline
              - unknown
          hasApiSession:
            type: boolean
          isMfaEnabled:
            type: boolean
          authPolicyId:
            type: string
          authPolicy:
            $ref: 'base-entity.yml#/definitions/entityRef'
          defaultHostingPrecedence:
            $ref: 'terminators.yml#/definitions/terminatorPrecedence'
          defaultHostingCost:
            $ref: 'terminators.yml#/definitions/terminatorCost'
          serviceHostingPrecedences:
            $ref: 'terminators.yml#/definitions/terminatorPrecedenceMap'
          serviceHostingCosts:
            $ref: 'terminators.yml#/definitions/terminatorCostMap'
          appData:
            $ref: 'base-entity.yml#/definitions/tags'
          externalId:
            type: string
            x-nullable: true
          disabled:
            type: boolean
          disabledAt:
            type: string
            format: date-time
            x-nullable: true
          disabledUntil:
            type: string
            format: date-time
            x-nullable: true
          interfaces:
            type: array
            items:
              $ref: '../shared/interfaces.yml#/definitions/interface'
          permissions:
            $ref: '../shared/base-entity.yml#/definitions/permissions'

  identityAuthenticators:
    type: object
    properties:
      updb:
        properties:
          id:
            type: string
          username:
            type: string
        type: object
      cert:
        type: object
        properties:
          id:
            type: string
          fingerprint:
            type: string
  identityEnrollments:
    type: object
    properties:
      updb:
        type: object
        properties:
          id:
            type: string
          token:
            type: string
          jwt:
            type: string
          expiresAt:
            type: string
            format: date-time
      ott:
        type: object
        properties:
          id:
            type: string
          token:
            type: string
          jwt:
            type: string
          expiresAt:
            type: string
            format: date-time
      ottca:
        type: object
        properties:
          id:
            type: string
          token:
            type: string
          jwt:
            type: string
          caId:
            type: string
          ca:
            $ref: 'base-entity.yml#/definitions/entityRef'
          expiresAt:
            type: string
            format: date-time