Microsoft Azure Common Incident Types

swagger: '2.0'
info:
  version: 2024-01-01-preview
  title: Microsoft Azure Common Incident types
paths: {}
definitions:
  IncidentClassificationEnum:
    description: The reason the incident was closed
    enum:
      - Undetermined
      - TruePositive
      - BenignPositive
      - FalsePositive
    type: string
    x-ms-enum:
      modelAsString: true
      name: IncidentClassification
      values:
        - description: Incident classification was undetermined
          value: Undetermined
        - description: Incident was true positive
          value: TruePositive
        - description: Incident was benign positive
          value: BenignPositive
        - description: Incident was false positive
          value: FalsePositive
  IncidentClassificationReasonEnum:
    description: The classification reason the incident was closed with
    enum:
      - SuspiciousActivity
      - SuspiciousButExpected
      - IncorrectAlertLogic
      - InaccurateData
    type: string
    x-ms-enum:
      modelAsString: true
      name: IncidentClassificationReason
      values:
        - description: Classification reason was suspicious activity
          value: SuspiciousActivity
        - description: Classification reason was suspicious but expected
          value: SuspiciousButExpected
        - description: Classification reason was incorrect alert logic
          value: IncorrectAlertLogic
        - description: Classification reason was inaccurate data
          value: InaccurateData
  IncidentLabel:
    description: Represents an incident label
    properties:
      labelName:
        description: The name of the label
        type: string
      labelType:
        $ref: '#/definitions/IncidentLabelType'
    required:
      - labelName
    type: object
  IncidentLabelType:
    description: The type of the label
    enum:
      - User
      - AutoAssigned
    type: string
    readOnly: true
    x-ms-enum:
      modelAsString: true
      name: IncidentLabelType
      values:
        - description: Label manually created by a user
          value: User
        - description: Label automatically created by the system
          value: AutoAssigned
  IncidentSeverityEnum:
    description: The severity of the incident
    enum:
      - High
      - Medium
      - Low
      - Informational
    type: string
    x-ms-enum:
      modelAsString: true
      name: IncidentSeverity
      values:
        - description: High severity
          value: High
        - description: Medium severity
          value: Medium
        - description: Low severity
          value: Low
        - description: Informational severity
          value: Informational
  IncidentStatusEnum:
    description: The status of the incident
    enum:
      - New
      - Active
      - Closed
    type: string
    x-ms-enum:
      modelAsString: true
      name: IncidentStatus
      values:
        - description: An active incident which isn't being handled currently
          value: New
        - description: An active incident which is being handled
          value: Active
        - description: A non-active incident
          value: Closed
  IncidentOwnerInfo:
    description: Information on the user an incident is assigned to
    properties:
      email:
        description: The email of the user the incident is assigned to.
        type: string
      assignedTo:
        description: The name of the user the incident is assigned to.
        type: string
      objectId:
        description: The object id of the user the incident is assigned to.
        format: uuid
        type: string
      userPrincipalName:
        description: The user principal name of the user the incident is assigned to.
        type: string
      ownerType:
        description: The type of the owner the incident is assigned to.
        type: string
        enum:
          - Unknown
          - User
          - Group
        x-ms-enum:
          modelAsString: true
          name: OwnerType
          values:
            - description: The incident owner type is unknown
              value: Unknown
            - description: The incident owner type is an AAD user
              value: User
            - description: The incident owner type is an AAD group
              value: Group
    type: object
  IncidentInfo:
    description: Describes related incident information for the bookmark
    properties:
      incidentId:
        description: Incident Id
        type: string
      severity:
        description: The severity of the incident
        type: string
        $ref: '#/definitions/IncidentSeverityEnum'
      title:
        description: The title of the incident
        type: string
      relationName:
        description: Relation Name
        type: string
    type: object
parameters: {}