Octopoes Models

octopoes.models.ooi.service

pydantic model octopoes.models.ooi.service.IPService[source]

Show JSON schema
{
   "title": "IPService",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "IPService",
         "default": "IPService",
         "enum": [
            "IPService"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "ip_port": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "IPPort",
         "title": "Ip Port",
         "type": "string"
      },
      "service": {
         "max_inherit_scan_level": 0,
         "max_issue_scan_level": 1,
         "object_type": "Service",
         "title": "Service",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "ip_port",
      "service"
   ]
}

Fields:
field ip_port: Reference [Required]
field object_type: Literal['IPService'] = 'IPService'
field service: Reference [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.service.Service[source]

Show JSON schema
{
   "title": "Service",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "Service",
         "default": "Service",
         "enum": [
            "Service"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field name: str [Required]
field object_type: Literal['Service'] = 'Service'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.service.TLSCipher[source]

Show JSON schema
{
   "title": "TLSCipher",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "TLSCipher",
         "default": "TLSCipher",
         "enum": [
            "TLSCipher"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "ip_service": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "IPService",
         "title": "Ip Service",
         "type": "string"
      },
      "suites": {
         "title": "Suites",
         "type": "object"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "ip_service",
      "suites"
   ]
}

Fields:
field ip_service: Reference [Required]
field object_type: Literal['TLSCipher'] = 'TLSCipher'
field suites: dict [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

octopoes.models.ooi.findings

pydantic model octopoes.models.ooi.findings.ADRFindingType[source]

Show JSON schema
{
   "title": "ADRFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "ADRFindingType",
         "default": "ADRFindingType",
         "enum": [
            "ADRFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['ADRFindingType'] = 'ADRFindingType'
pydantic model octopoes.models.ooi.findings.CAPECFindingType[source]

Show JSON schema
{
   "title": "CAPECFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "CAPECFindingType",
         "default": "CAPECFindingType",
         "enum": [
            "CAPECFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['CAPECFindingType'] = 'CAPECFindingType'
pydantic model octopoes.models.ooi.findings.CVEFindingType[source]

Show JSON schema
{
   "title": "CVEFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "CVEFindingType",
         "default": "CVEFindingType",
         "enum": [
            "CVEFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['CVEFindingType'] = 'CVEFindingType'
pydantic model octopoes.models.ooi.findings.CWEFindingType[source]

Show JSON schema
{
   "title": "CWEFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "CWEFindingType",
         "default": "CWEFindingType",
         "enum": [
            "CWEFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['CWEFindingType'] = 'CWEFindingType'
pydantic model octopoes.models.ooi.findings.Finding[source]

Show JSON schema
{
   "title": "Finding",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "Finding",
         "default": "Finding",
         "enum": [
            "Finding"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "finding_type": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "FindingType",
         "title": "Finding Type",
         "type": "string"
      },
      "ooi": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "OOI",
         "title": "Ooi",
         "type": "string"
      },
      "proof": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Proof"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "reproduce": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Reproduce"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "finding_type",
      "ooi"
   ]
}

Fields:
field description: str | None = None
field finding_type: Reference [Required]
field object_type: Literal['Finding'] = 'Finding'
field ooi: Reference [Required]
field proof: str | None = None
field reproduce: str | None = None
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

property natural_key: str
pydantic model octopoes.models.ooi.findings.FindingType[source]

Show JSON schema
{
   "title": "FindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "object_type",
      "id"
   ]
}

Fields:
field description: str | None = None
field id: str [Required]
field impact: str | None = None
field recommendation: str | None = None
field risk_score: float | None = None
field risk_severity: RiskLevelSeverity | None = None
field source: Url | None = None
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.findings.KATFindingType[source]

Show JSON schema
{
   "title": "KATFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "KATFindingType",
         "default": "KATFindingType",
         "enum": [
            "KATFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['KATFindingType'] = 'KATFindingType'
pydantic model octopoes.models.ooi.findings.MutedFinding[source]

Show JSON schema
{
   "title": "MutedFinding",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "MutedFinding",
         "default": "MutedFinding",
         "enum": [
            "MutedFinding"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "finding": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Finding",
         "title": "Finding",
         "type": "string"
      },
      "reason": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Reason"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "finding"
   ]
}

Fields:
field finding: Reference [Required]
field object_type: Literal['MutedFinding'] = 'MutedFinding'
field reason: str | None = None
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.findings.RetireJSFindingType[source]

Show JSON schema
{
   "title": "RetireJSFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "RetireJSFindingType",
         "default": "RetireJSFindingType",
         "enum": [
            "RetireJSFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['RetireJSFindingType'] = 'RetireJSFindingType'
class octopoes.models.ooi.findings.RiskLevelSeverity(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
pydantic model octopoes.models.ooi.findings.SnykFindingType[source]

Show JSON schema
{
   "title": "SnykFindingType",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "SnykFindingType",
         "default": "SnykFindingType",
         "enum": [
            "SnykFindingType"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "source": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source"
      },
      "impact": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Impact"
      },
      "recommendation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommendation"
      },
      "risk_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk Score"
      },
      "risk_severity": {
         "anyOf": [
            {
               "$ref": "#/$defs/RiskLevelSeverity"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "RiskLevelSeverity": {
         "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "recommendation",
            "pending",
            "unknown"
         ],
         "title": "RiskLevelSeverity",
         "type": "string"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field object_type: Literal['SnykFindingType'] = 'SnykFindingType'

octopoes.models.ooi.email_security

pydantic model octopoes.models.ooi.email_security.DKIMExists[source]

Show JSON schema
{
   "title": "DKIMExists",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DKIMExists",
         "default": "DKIMExists",
         "enum": [
            "DKIMExists"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "hostname": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Hostname",
         "title": "Hostname",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "hostname"
   ]
}

Fields:
field hostname: Reference [Required]
field object_type: Literal['DKIMExists'] = 'DKIMExists'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DKIMKey[source]

Show JSON schema
{
   "title": "DKIMKey",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DKIMKey",
         "default": "DKIMKey",
         "enum": [
            "DKIMKey"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "key": {
         "title": "Key",
         "type": "string"
      },
      "dkim_selector": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "DKIMSelector",
         "title": "Dkim Selector",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "key",
      "dkim_selector"
   ]
}

Fields:
field dkim_selector: Reference [Required]
field key: str [Required]
field object_type: Literal['DKIMKey'] = 'DKIMKey'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DKIMSelector[source]

Show JSON schema
{
   "title": "DKIMSelector",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DKIMSelector",
         "default": "DKIMSelector",
         "enum": [
            "DKIMSelector"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "selector": {
         "title": "Selector",
         "type": "string"
      },
      "hostname": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Hostname",
         "title": "Hostname",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "selector",
      "hostname"
   ]
}

Fields:
field hostname: Reference [Required]
field object_type: Literal['DKIMSelector'] = 'DKIMSelector'
field selector: str [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DMARCTXTRecord[source]

Show JSON schema
{
   "title": "DMARCTXTRecord",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DMARCTXTRecord",
         "default": "DMARCTXTRecord",
         "enum": [
            "DMARCTXTRecord"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "string"
      },
      "ttl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "title": "Ttl"
      },
      "hostname": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Hostname",
         "title": "Hostname",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "value",
      "ttl",
      "hostname"
   ]
}

Fields:
field hostname: Reference [Required]
field object_type: Literal['DMARCTXTRecord'] = 'DMARCTXTRecord'
field ttl: int | None [Required]
field value: str [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DNSSPFMechanism[source]

Show JSON schema
{
   "title": "DNSSPFMechanism",
   "type": "object",
   "properties": {
      "object_type": {
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "spf_record": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": null,
         "object_type": "DNSSPFRecord",
         "title": "Spf Record",
         "type": "string"
      },
      "mechanism": {
         "title": "Mechanism",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "object_type",
      "spf_record",
      "mechanism"
   ]
}

Fields:
field mechanism: str [Required]
field spf_record: Reference [Required]
pydantic model octopoes.models.ooi.email_security.DNSSPFMechanismHostname[source]

Show JSON schema
{
   "title": "DNSSPFMechanismHostname",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DNSSPFMechanismHostname",
         "default": "DNSSPFMechanismHostname",
         "enum": [
            "DNSSPFMechanismHostname"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "spf_record": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": null,
         "object_type": "DNSSPFRecord",
         "title": "Spf Record",
         "type": "string"
      },
      "mechanism": {
         "title": "Mechanism",
         "type": "string"
      },
      "hostname": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Hostname",
         "title": "Hostname",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "spf_record",
      "mechanism",
      "hostname"
   ]
}

Fields:
field hostname: Reference [Required]
field object_type: Literal['DNSSPFMechanismHostname'] = 'DNSSPFMechanismHostname'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DNSSPFMechanismIP[source]

Show JSON schema
{
   "title": "DNSSPFMechanismIP",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DNSSPFMechanismIP",
         "default": "DNSSPFMechanismIP",
         "enum": [
            "DNSSPFMechanismIP"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "spf_record": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": null,
         "object_type": "DNSSPFRecord",
         "title": "Spf Record",
         "type": "string"
      },
      "mechanism": {
         "title": "Mechanism",
         "type": "string"
      },
      "ip": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "IPAddress",
         "title": "Ip",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "spf_record",
      "mechanism",
      "ip"
   ]
}

Fields:
field ip: Reference [Required]
field object_type: Literal['DNSSPFMechanismIP'] = 'DNSSPFMechanismIP'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DNSSPFMechanismNetBlock[source]

Show JSON schema
{
   "title": "DNSSPFMechanismNetBlock",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DNSSPFMechanismNetBlock",
         "default": "DNSSPFMechanismNetBlock",
         "enum": [
            "DNSSPFMechanismNetBlock"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "spf_record": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": null,
         "object_type": "DNSSPFRecord",
         "title": "Spf Record",
         "type": "string"
      },
      "mechanism": {
         "title": "Mechanism",
         "type": "string"
      },
      "netblock": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "NetBlock",
         "title": "Netblock",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "spf_record",
      "mechanism",
      "netblock"
   ]
}

Fields:
field netblock: Reference [Required]
field object_type: Literal['DNSSPFMechanismNetBlock'] = 'DNSSPFMechanismNetBlock'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.email_security.DNSSPFRecord[source]

Show JSON schema
{
   "title": "DNSSPFRecord",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "DNSSPFRecord",
         "default": "DNSSPFRecord",
         "enum": [
            "DNSSPFRecord"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "string"
      },
      "ttl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ttl"
      },
      "all": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "All"
      },
      "exp": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Exp"
      },
      "dns_txt_record": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": null,
         "object_type": "DNSTXTRecord",
         "title": "Dns Txt Record",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "value",
      "dns_txt_record"
   ]
}

Fields:
field all: str | None = None
field dns_txt_record: Reference [Required]
field exp: str | None = None
field object_type: Literal['DNSSPFRecord'] = 'DNSSPFRecord'
field ttl: int | None = None
field value: str [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

property natural_key: str

octopoes.models.ooi.web

pydantic model octopoes.models.ooi.web.APIDesignRule[source]

Show JSON schema
{
   "title": "APIDesignRule",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "APIDesignRule",
         "default": "APIDesignRule",
         "enum": [
            "APIDesignRule"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field name: str [Required]
field object_type: Literal['APIDesignRule'] = 'APIDesignRule'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.APIDesignRuleResult[source]

Show JSON schema
{
   "title": "APIDesignRuleResult",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "APIDesignRuleResult",
         "default": "APIDesignRuleResult",
         "enum": [
            "APIDesignRuleResult"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "rest_api": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "RESTAPI",
         "title": "Rest Api",
         "type": "string"
      },
      "rule": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "APIDesignRule",
         "title": "Rule",
         "type": "string"
      },
      "passed": {
         "title": "Passed",
         "type": "boolean"
      },
      "message": {
         "title": "Message",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "rest_api",
      "rule",
      "passed",
      "message"
   ]
}

Fields:
field message: str [Required]
field object_type: Literal['APIDesignRuleResult'] = 'APIDesignRuleResult'
field passed: bool [Required]
field rest_api: Reference [Required]
field rule: Reference [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.HTTPHeader[source]

Show JSON schema
{
   "title": "HTTPHeader",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "HTTPHeader",
         "default": "HTTPHeader",
         "enum": [
            "HTTPHeader"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "resource": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "HTTPResource",
         "title": "Resource",
         "type": "string"
      },
      "key": {
         "title": "Key",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "resource",
      "key",
      "value"
   ]
}

Fields:
field key: str [Required]
field object_type: Literal['HTTPHeader'] = 'HTTPHeader'
field resource: Reference [Required]
field value: str [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.HTTPHeaderHostname[source]

Show JSON schema
{
   "title": "HTTPHeaderHostname",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "HTTPHeaderHostname",
         "default": "HTTPHeaderHostname",
         "enum": [
            "HTTPHeaderHostname"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "header": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": 0,
         "object_type": "HTTPHeader",
         "title": "Header",
         "type": "string"
      },
      "hostname": {
         "max_inherit_scan_level": 0,
         "max_issue_scan_level": 1,
         "object_type": "Hostname",
         "title": "Hostname",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "header",
      "hostname"
   ]
}

Fields:
field header: Reference [Required]
field hostname: Reference [Required]
field object_type: Literal['HTTPHeaderHostname'] = 'HTTPHeaderHostname'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.HTTPHeaderURL[source]

Show JSON schema
{
   "title": "HTTPHeaderURL",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "HTTPHeaderURL",
         "default": "HTTPHeaderURL",
         "enum": [
            "HTTPHeaderURL"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "header": {
         "max_inherit_scan_level": 1,
         "max_issue_scan_level": 0,
         "object_type": "HTTPHeader",
         "title": "Header",
         "type": "string"
      },
      "url": {
         "max_inherit_scan_level": 0,
         "max_issue_scan_level": 1,
         "object_type": "URL",
         "title": "Url",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "header",
      "url"
   ]
}

Fields:
field header: Reference [Required]
field object_type: Literal['HTTPHeaderURL'] = 'HTTPHeaderURL'
field url: Reference [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.HTTPResource[source]

Show JSON schema
{
   "title": "HTTPResource",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "HTTPResource",
         "default": "HTTPResource",
         "enum": [
            "HTTPResource"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "website": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "Website",
         "title": "Website",
         "type": "string"
      },
      "web_url": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 1,
         "object_type": "WebURL",
         "title": "Web Url",
         "type": "string"
      },
      "redirects_to": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "WebURL",
         "title": "Redirects To"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "website",
      "web_url"
   ]
}

Fields:
field object_type: Literal['HTTPResource'] = 'HTTPResource'
field redirects_to: Reference | None = None
field web_url: Reference [Required]
field website: Reference [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.HostnameHTTPURL[source]

Show JSON schema
{
   "title": "HostnameHTTPURL",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "HostnameHTTPURL",
         "default": "HostnameHTTPURL",
         "enum": [
            "HostnameHTTPURL"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "network": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Network",
         "title": "Network",
         "type": "string"
      },
      "scheme": {
         "$ref": "#/$defs/WebScheme"
      },
      "port": {
         "title": "Port",
         "type": "integer"
      },
      "path": {
         "title": "Path",
         "type": "string"
      },
      "netloc": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 2,
         "object_type": "Hostname",
         "title": "Netloc",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      },
      "WebScheme": {
         "enum": [
            "http",
            "https"
         ],
         "title": "WebScheme",
         "type": "string"
      }
   },
   "required": [
      "network",
      "scheme",
      "port",
      "path",
      "netloc"
   ]
}

Fields:
field netloc: Reference [Required]
field object_type: Literal['HostnameHTTPURL'] = 'HostnameHTTPURL'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.IPAddressHTTPURL[source]

Show JSON schema
{
   "title": "IPAddressHTTPURL",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "IPAddressHTTPURL",
         "default": "IPAddressHTTPURL",
         "enum": [
            "IPAddressHTTPURL"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "network": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Network",
         "title": "Network",
         "type": "string"
      },
      "scheme": {
         "$ref": "#/$defs/WebScheme"
      },
      "port": {
         "title": "Port",
         "type": "integer"
      },
      "path": {
         "title": "Path",
         "type": "string"
      },
      "netloc": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 1,
         "object_type": "IPAddress",
         "title": "Netloc",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      },
      "WebScheme": {
         "enum": [
            "http",
            "https"
         ],
         "title": "WebScheme",
         "type": "string"
      }
   },
   "required": [
      "network",
      "scheme",
      "port",
      "path",
      "netloc"
   ]
}

Fields:
field netloc: Reference [Required]
field object_type: Literal['IPAddressHTTPURL'] = 'IPAddressHTTPURL'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.ImageMetadata[source]

Show JSON schema
{
   "title": "ImageMetadata",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "ImageMetadata",
         "default": "ImageMetadata",
         "enum": [
            "ImageMetadata"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "resource": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "HTTPResource",
         "title": "Resource",
         "type": "string"
      },
      "image_info": {
         "title": "Image Info",
         "type": "object"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "resource",
      "image_info"
   ]
}

Fields:
field image_info: dict [Required]
field object_type: Literal['ImageMetadata'] = 'ImageMetadata'
field resource: Reference [Required]
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.RESTAPI[source]

Show JSON schema
{
   "title": "RESTAPI",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "RESTAPI",
         "default": "RESTAPI",
         "enum": [
            "RESTAPI"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "api_url": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "WebURL",
         "title": "Api Url",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "api_url"
   ]
}

Fields:
field api_url: Reference [Required]
field object_type: Literal['RESTAPI'] = 'RESTAPI'
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.SecurityTXT[source]

Show JSON schema
{
   "title": "SecurityTXT",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "SecurityTXT",
         "default": "SecurityTXT",
         "enum": [
            "SecurityTXT"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "website": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "Website",
         "title": "Website",
         "type": "string"
      },
      "url": {
         "max_inherit_scan_level": 4,
         "max_issue_scan_level": 0,
         "object_type": "URL",
         "title": "Url",
         "type": "string"
      },
      "redirects_to": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "max_inherit_scan_level": 0,
         "max_issue_scan_level": 2,
         "object_type": "SecurityTXT",
         "title": "Redirects To"
      },
      "security_txt": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Security Txt"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "website",
      "url"
   ]
}

Fields:
field object_type: Literal['SecurityTXT'] = 'SecurityTXT'
field redirects_to: Reference | None = None
field security_txt: str | None = None
field url: Reference [Required]
field website: Reference [Required]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

pydantic model octopoes.models.ooi.web.URL[source]

Show JSON schema
{
   "title": "URL",
   "type": "object",
   "properties": {
      "object_type": {
         "const": "URL",
         "default": "URL",
         "enum": [
            "URL"
         ],
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "network": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Network",
         "title": "Network",
         "type": "string"
      },
      "raw": {
         "format": "uri",
         "minLength": 1,
         "title": "Raw",
         "type": "string"
      },
      "web_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "max_inherit_scan_level": null,
         "max_issue_scan_level": 2,
         "object_type": "WebURL",
         "title": "Web Url"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      }
   },
   "required": [
      "network",
      "raw"
   ]
}

Fields:
field network: Reference [Required]
field object_type: Literal['URL'] = 'URL'
field raw: Url [Required]
field web_url: Reference | None = None
classmethod format_reference_human_readable(reference: Reference) str[source]
model_post_init(_ModelMetaclass__context: Any) None

We need to both initialize private attributes and call the user-defined model_post_init method.

class octopoes.models.ooi.web.WebScheme(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
pydantic model octopoes.models.ooi.web.WebURL[source]

Show JSON schema
{
   "title": "WebURL",
   "type": "object",
   "properties": {
      "object_type": {
         "title": "Object Type",
         "type": "string"
      },
      "scan_profile": {
         "anyOf": [
            {
               "$ref": "#/$defs/EmptyScanProfile"
            },
            {
               "$ref": "#/$defs/InheritedScanProfile"
            },
            {
               "$ref": "#/$defs/DeclaredScanProfile"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scan Profile"
      },
      "primary_key": {
         "default": "",
         "title": "Primary Key",
         "type": "string"
      },
      "network": {
         "max_inherit_scan_level": null,
         "max_issue_scan_level": null,
         "object_type": "Network",
         "title": "Network",
         "type": "string"
      },
      "scheme": {
         "$ref": "#/$defs/WebScheme"
      },
      "port": {
         "title": "Port",
         "type": "integer"
      },
      "path": {
         "title": "Path",
         "type": "string"
      }
   },
   "$defs": {
      "DeclaredScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "declared",
               "default": "declared",
               "enum": [
                  "declared"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "DeclaredScanProfile",
         "type": "object"
      },
      "EmptyScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "empty",
               "default": "empty",
               "enum": [
                  "empty"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "allOf": [
                  {
                     "$ref": "#/$defs/ScanLevel"
                  }
               ],
               "default": 0
            }
         },
         "required": [
            "reference"
         ],
         "title": "EmptyScanProfile",
         "type": "object"
      },
      "InheritedScanProfile": {
         "properties": {
            "scan_profile_type": {
               "const": "inherited",
               "default": "inherited",
               "enum": [
                  "inherited"
               ],
               "title": "Scan Profile Type",
               "type": "string"
            },
            "reference": {
               "title": "Reference",
               "type": "string"
            },
            "level": {
               "$ref": "#/$defs/ScanLevel"
            }
         },
         "required": [
            "reference",
            "level"
         ],
         "title": "InheritedScanProfile",
         "type": "object"
      },
      "ScanLevel": {
         "enum": [
            0,
            1,
            2,
            3,
            4
         ],
         "title": "ScanLevel",
         "type": "integer"
      },
      "WebScheme": {
         "enum": [
            "http",
            "https"
         ],
         "title": "WebScheme",
         "type": "string"
      }
   },
   "required": [
      "object_type",
      "network",
      "scheme",
      "port",
      "path"
   ]
}

Fields: