edge-api/source/shared/base-entity.yml

---
definitions:
  baseEntity:
    description: Fields shared by all Edge API entities
    type: object
    required:
      - id
      - createdAt
      - updatedAt
      - _links
    properties:
      id:
        type: string
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      _links:
        $ref: '#/definitions/links'
      tags:
        $ref: '#/definitions/tags'
  link:
    description: A link to another resource
    type: object
    required:
      - href
    properties:
      href:
        type: string
        format: uri
      method:
        type: string
      comment:
        type: string
  links:
    description: A map of named links
    type: object
    x-omitempty: false
    additionalProperties:
      $ref: '#/definitions/link'
  entityRef:
    description: A reference to another resource and links to interact with it
    type: object
    properties:
      entity:
        type: string
      id:
        type: string
      name:
        type: string
      _links:
        $ref: '#/definitions/links'
  tags:
    description: 'A map of user defined fields and values. The values are limited to the following types/values: null, string, boolean'
    allOf:
      - $ref: '#/definitions/subTags'
    x-nullable: true
  subTags:
    type: object
    additionalProperties: {
      type: object
    }
  attributes:
    description: A set of strings used to loosely couple this resource to policies
    type: array
    x-omitempty: true
    x-nullable: true
    items:
      type: string
  permissions:
    description: A set of strings used to define which types of resources this resource can acccess
    type: array
    x-omitempty: true
    x-nullable: true
    items:
      type: string
      enum:
        - "admin_readonly"

        - "auth-policy"
        - "auth-policy.read"
        - "auth-policy.create"
        - "auth-policy.update"
        - "auth-policy.delete"

        - "ca"
        - "ca.read"
        - "ca.create"
        - "ca.update"
        - "ca.delete"

        - "config"
        - "config.read"
        - "config.create"
        - "config.update"
        - "config.delete"

        - "config-type"
        - "config-type.read"
        - "config-type.create"
        - "config-type.update"
        - "config-type.delete"

        - "edge-router-policy"
        - "edge-router-policy.read"
        - "edge-router-policy.create"
        - "edge-router-policy.update"
        - "edge-router-policy.delete"

        - "enrollment"
        - "enrollment.read"
        - "enrollment.create"
        - "enrollment.update"
        - "enrollment.delete"

        - "external-jwt-signer"
        - "external-jwt-signer.read"
        - "external-jwt-signer.create"
        - "external-jwt-signer.update"
        - "external-jwt-signer.delete"

        - "identity"
        - "identity.read"
        - "identity.create"
        - "identity.update"
        - "identity.delete"

        - "ops"
        - "ops.read"
        - "ops.update"
        - "ops.delete"

        - "posture-check"
        - "posture-check.read"
        - "posture-check.create"
        - "posture-check.update"
        - "posture-check.delete"

        - "router"
        - "router.read"
        - "router.create"
        - "router.update"
        - "router.delete"

        - "service"
        - "service.read"
        - "service.create"
        - "service.update"
        - "service.delete"

        - "service-edge-router-policy"
        - "service-edge-router-policy.read"
        - "service-edge-router-policy.create"
        - "service-edge-router-policy.update"
        - "service-edge-router-policy.delete"

        - "service-policy"
        - "service-policy.read"
        - "service-policy.create"
        - "service-policy.update"
        - "service-policy.delete"

        - "terminator"
        - "terminator.read"
        - "terminator.create"
        - "terminator.update"
        - "terminator.delete"
  roles:
    type: array
    x-omitempty: false
    items:
      type: string
  namedRole:
    type: object
    properties:
      role:
        type: string
      name:
        type: string
  namedRoles:
    type: array
    x-omitempty: false
    items:
      $ref: '#/definitions/namedRole'
  semantic:
    type: string
    enum:
      - AllOf
      - AnyOf
  dialBind:
    type: string
    enum:
      - Dial
      - Bind
      - Invalid
  dialBindArray:
    type: array
    items:
      $ref: '#/definitions/dialBind'