{ "components": { "parameters": { "DiscoveryAwsKeyUsageParams": { "explode": true, "in": "query", "name": "DiscoveryAwsKeyUsageParams", "schema": { "$ref": "#/components/schemas/DiscoveryAwsKeyUsageParams" } }, "DiscoveryAwsScannedServicesReportByAccountParams": { "explode": true, "in": "query", "name": "DiscoveryAwsScannedServicesReportByAccountParams", "schema": { "$ref": "#/components/schemas/DiscoveryAwsScannedServicesReportByAccountParams" } }, "DiscoveryAzureKeyUsageParams": { "explode": true, "in": "query", "name": "DiscoveryAzureKeyUsageParams", "schema": { "$ref": "#/components/schemas/DiscoveryAzureKeyUsageParams" } }, "DiscoveryAzureScannedServicesReportBySubscriptionParams": { "explode": true, "in": "query", "name": "DiscoveryAzureScannedServicesReportBySubscriptionParams", "schema": { "$ref": "#/components/schemas/DiscoveryAzureScannedServicesReportBySubscriptionParams" } }, "DiscoveryGetAllConnectionsParams": { "explode": true, "in": "query", "name": "DiscoveryGetAllConnectionsParams", "schema": { "$ref": "#/components/schemas/DiscoveryGetAllConnectionsParams" } }, "DiscoveryGetAllPoliciesParams": { "explode": true, "in": "query", "name": "DiscoveryGetAllPoliciesParams", "schema": { "$ref": "#/components/schemas/DiscoveryGetAllPoliciesParams" } }, "DiscoveryInventoryObjectsParams": { "explode": true, "in": "query", "name": "DiscoveryInventoryObjectsParams", "schema": { "$ref": "#/components/schemas/DiscoveryInventoryObjectsParams" } }, "DiscoveryPqcReportConnectionParams": { "explode": true, "in": "query", "name": "DiscoveryPqcReportConnectionParams", "schema": { "$ref": "#/components/schemas/DiscoveryPqcReportConnectionParams" } }, "DiscoveryPqcReportServiceParams": { "explode": true, "in": "query", "name": "DiscoveryPqcReportServiceParams", "schema": { "$ref": "#/components/schemas/DiscoveryPqcReportServiceParams" } }, "DiscoveryScanInventoryObjectsParams": { "explode": true, "in": "query", "name": "DiscoveryScanInventoryObjectsParams", "schema": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectsParams" } }, "DiscoveryScanParams": { "explode": true, "in": "query", "name": "DiscoveryScanParams", "schema": { "$ref": "#/components/schemas/DiscoveryScanParams" } }, "DiscoveryScannedAwsAccountsParams": { "explode": true, "in": "query", "name": "DiscoveryScannedAwsAccountsParams", "schema": { "$ref": "#/components/schemas/DiscoveryScannedAwsAccountsParams" } }, "DiscoveryScannedAzureSubscriptionsParams": { "explode": true, "in": "query", "name": "DiscoveryScannedAzureSubscriptionsParams", "schema": { "$ref": "#/components/schemas/DiscoveryScannedAzureSubscriptionsParams" } }, "DiscoveryScannedServicesReportByServiceTypeParams": { "explode": true, "in": "query", "name": "DiscoveryScannedServicesReportByServiceTypeParams", "schema": { "$ref": "#/components/schemas/DiscoveryScannedServicesReportByServiceTypeParams" } }, "DiscoveryScannedServicesReportByViolationTypeParams": { "explode": true, "in": "query", "name": "DiscoveryScannedServicesReportByViolationTypeParams", "schema": { "$ref": "#/components/schemas/DiscoveryScannedServicesReportByViolationTypeParams" } } }, "schemas": { "DiscoveryAcmCertificate": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAcmCertificateAnalysis" }, "certificate_arn": { "type": "string" }, "created_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "domain_name": { "type": "string" }, "extended_key_usages": { "items": { "$ref": "#/components/schemas/DiscoveryAcmCertificateExtendedKeyUsage" }, "nullable": true, "type": "array" }, "issuer": { "type": "string" }, "key_algorithm": { "$ref": "#/components/schemas/DiscoveryAcmCertificateKeyAlgorithm" }, "not_valid_after": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "not_valid_before": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "renewal_eligibility": { "$ref": "#/components/schemas/DiscoveryAcmCertificateRenewalEligibility" }, "serial": { "type": "string" }, "signature_algorithm": { "$ref": "#/components/schemas/DiscoveryAcmCertificateSignatureAlgorithm" }, "status": { "$ref": "#/components/schemas/DiscoveryAcmCertificateStatus" }, "subject_alternative_names": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "used_by_services": { "items": { "type": "string" }, "type": "array" } }, "required": [ "certificate_arn", "domain_name", "status", "renewal_eligibility", "issuer", "key_algorithm", "signature_algorithm", "serial", "used_by_services", "analysis" ], "type": "object" } ] }, "DiscoveryAcmCertificateAnalysis": { "allOf": [ { "properties": { "is_expired": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "key_algo_crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryAwsCryptoPolicyCompliance" }, "overly_permissive_usage_violation": { "type": "boolean" }, "signature_crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryAwsCryptoPolicyCompliance" } }, "required": [ "is_shared", "is_expired", "overly_permissive_usage_violation" ], "type": "object" } ] }, "DiscoveryAcmCertificateExtendedKeyUsage": { "allOf": [ { "properties": { "name": { "$ref": "#/components/schemas/DiscoveryAcmCertificateExtendedKeyUsageName" }, "object_identifier": { "nullable": true, "type": "string" } }, "required": ["name"], "type": "object" } ] }, "DiscoveryAcmCertificateExtendedKeyUsageName": { "enum": [ "any", "code_signing", "custom", "email_protection", "ipsec_end_system", "ipsec_tunnel", "ipsec_user", "none", "ocsp_signing", "time_stamping", "tls_web_server_authentication", "tls_web_client_authentication", "unknown" ], "type": "string" }, "DiscoveryAcmCertificateKeyAlgorithm": { "enum": ["rsa2048", "rsa3072", "rsa4096", "unknown"], "type": "string" }, "DiscoveryAcmCertificateRenewalEligibility": { "enum": ["ineligible", "eligible", "unknown"], "type": "string" }, "DiscoveryAcmCertificateSignatureAlgorithm": { "enum": ["sha256_with_rsa", "sha512_with_rsa", "unknown"], "type": "string" }, "DiscoveryAcmCertificateStatus": { "enum": [ "expired", "pending", "issued", "failed", "inactive", "revoked", "validation_timed_out", "unknown" ], "type": "string" }, "DiscoveryAesOptionsPolicy": { "allOf": [ { "properties": { "fpe": { "$ref": "#/components/schemas/DiscoveryFpeOptions" }, "key_sizes": { "items": { "maximum": 4294967295, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "random_iv": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryAll": { "description": "A helper enum with a single variant, All, which indicates that something should apply to an\nentire part. (This is here mainly to allow other untagged enums to work properly.)", "enum": ["all"], "type": "string" }, "DiscoveryAriaOptionsPolicy": { "allOf": [ { "properties": { "key_sizes": { "items": { "maximum": 4294967295, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "random_iv": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryAwsAccount": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryAwsAccountDetails" }, "id": { "type": "string" } }, "required": ["id"], "type": "object" } ] }, "DiscoveryAwsAccountDetails": { "allOf": [ { "properties": { "name": { "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryAwsAccountKeysCount": { "allOf": [ { "properties": { "account": { "$ref": "#/components/schemas/DiscoveryAwsAccount" }, "enabled_keys": { "type": "integer" }, "total_keys": { "type": "integer" } }, "required": ["account", "total_keys", "enabled_keys"], "type": "object" } ] }, "DiscoveryAwsAccountViolationMetrics": { "allOf": [ { "properties": { "account_id": { "type": "string" }, "violations_by_region": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryAwsRegionViolationMetrics" }, "type": "object" } }, "required": ["account_id", "violations_by_region"], "type": "object" } ] }, "DiscoveryAwsCertificateAssessment": { "allOf": [ { "properties": { "expired_certificate_count": { "type": "integer" }, "expiry_metrics_by_issuer": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryExpiryMetrics" }, "type": "object" }, "non_compliant_certificate_by_key_algorithm_count": { "type": "integer" }, "non_compliant_certificate_by_signature_count": { "type": "integer" }, "overly_permissive_certificate_usage_count": { "type": "integer" }, "shared_certificate_count": { "type": "integer" }, "total_certificates": { "type": "integer" } }, "required": [ "total_certificates", "expiry_metrics_by_issuer", "expired_certificate_count", "shared_certificate_count", "non_compliant_certificate_by_key_algorithm_count", "non_compliant_certificate_by_signature_count", "overly_permissive_certificate_usage_count" ], "type": "object" } ] }, "DiscoveryAwsCloudDiscoveryData": { "allOf": [ { "properties": { "cross_account_keys": { "nullable": true, "type": "integer" }, "customer_managed_keys": { "nullable": true, "type": "integer" }, "platform_managed_keys": { "nullable": true, "type": "integer" }, "total_accounts": { "type": "integer" }, "total_certificates": { "nullable": true, "type": "integer" }, "total_keys": { "type": "integer" }, "total_regions": { "type": "integer" }, "total_services": { "type": "integer" } }, "required": [ "total_accounts", "total_regions", "total_keys", "total_services" ], "type": "object" } ] }, "DiscoveryAwsConfig": { "allOf": [ { "properties": { "aws_scope": { "$ref": "#/components/schemas/DiscoveryAwsScope" }, "creds": { "$ref": "#/components/schemas/DiscoveryAwsCredentials" }, "endpoint": { "format": "url", "nullable": true, "type": "string" }, "role_arn": { "description": "ARN for AWS Role configured for scanning AWS account/organization", "nullable": true, "type": "string" } }, "required": ["creds", "aws_scope"], "type": "object" } ] }, "DiscoveryAwsCredentials": { "discriminator": { "mapping": { "access_and_secret_key": "DiscoveryAwsCredentialsVariantAccessAndSecretKey", "open_id_connect": "DiscoveryAwsCredentialsVariantOpenIdConnect" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAwsCredentialsVariantAccessAndSecretKey" }, { "$ref": "#/components/schemas/DiscoveryAwsCredentialsVariantOpenIdConnect" } ] }, "DiscoveryAwsCredentialsAccessAndSecretKey": { "allOf": [ { "properties": { "access_key": { "type": "string" }, "secret_key": { "nullable": true, "type": "string" } }, "required": ["access_key"], "type": "object" } ] }, "DiscoveryAwsCredentialsOpenIdConnect": { "allOf": [ { "properties": { "auth_config_id": { "description": "Uuid for the AuthConfig object within Account", "format": "uuid", "type": "string" } }, "required": ["auth_config_id"], "type": "object" } ] }, "DiscoveryAwsCredentialsVariantAccessAndSecretKey": { "allOf": [ { "properties": { "$type": { "enum": ["access_and_secret_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsCredentialsAccessAndSecretKey" } ] }, "DiscoveryAwsCredentialsVariantOpenIdConnect": { "allOf": [ { "properties": { "$type": { "enum": ["open_id_connect"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsCredentialsOpenIdConnect" } ] }, "DiscoveryAwsCryptoPolicyCompliance": { "allOf": [ { "properties": { "is_compliant": { "type": "boolean" }, "violation_reason": { "nullable": true, "type": "string" } }, "required": ["is_compliant"], "type": "object" } ] }, "DiscoveryAwsDefaultServerSideEncryption": { "allOf": [ { "properties": { "kms_master_key": { "nullable": true, "type": "string" }, "sse_algorithm": { "$ref": "#/components/schemas/DiscoveryAwsSseAlgorithm" } }, "type": "object" } ] }, "DiscoveryAwsDynamoDbInstance": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsDynamoDbInstanceAnalysis" }, "identifier": { "nullable": true, "type": "string" }, "kms_key_id": { "nullable": true, "type": "string" } }, "required": ["analysis"], "type": "object" } ] }, "DiscoveryAwsDynamoDbInstanceAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsEbsVolume": { "allOf": [ { "description": "Internal model to describe an AWS EBS volume.\n\nThis is a selection of the fields most relevant for the current dashboard and could be\nupdated to include more fields in the future.", "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsEbsVolumeAnalysis" }, "availability_zone": { "description": "The region this volume will be available", "type": "string" }, "kms_key_id": { "description": "The arn of the key in KMS that encrypts this drive", "nullable": true, "type": "string" }, "volume_id": { "description": "The ARN of the volume", "nullable": true, "type": "string" }, "volume_size": { "description": "The storage limit (in GB) of the volume", "format": "int32", "nullable": true, "type": "integer" }, "volume_state": { "$ref": "#/components/schemas/DiscoveryAwsEbsVolumeState" }, "volume_type": { "$ref": "#/components/schemas/DiscoveryAwsEbsVolumeType" } }, "required": ["availability_zone", "analysis"], "type": "object" } ] }, "DiscoveryAwsEbsVolumeAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsEbsVolumeState": { "description": "Enumeration of the states that a volume may occupy.\n\nThis enum will default to the `Other` variant when a new variant is\nfound as the SDK from AWS marks their enum as \"non-exhaustive\"", "enum": [ "available", "creating", "deleted", "deleting", "error", "in_use", "other" ], "type": "string" }, "DiscoveryAwsEbsVolumeType": { "description": "Enumeration of the various types of volumes supported.\n\nThis enum will default to the `Other` variant when a new variant is\nfound as the SDK from AWS marks their enum as \"non-exhaustive\"", "enum": ["gp2", "gp3", "io1", "io2", "sc1", "st1", "standard", "other"], "type": "string" }, "DiscoveryAwsEfsFileSystem": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsEfsFileSystemAnalysis" }, "file_system_id": { "type": "string" }, "kms_key_id": { "nullable": true, "type": "string" }, "life_cycle_state": { "$ref": "#/components/schemas/DiscoveryAwsEfsLifeCycleState" }, "size": { "format": "int64", "nullable": true, "type": "integer" } }, "required": ["file_system_id", "life_cycle_state", "analysis"], "type": "object" } ] }, "DiscoveryAwsEfsFileSystemAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsEfsLifeCycleState": { "enum": [ "available", "creating", "deleted", "deleting", "error", "updating", "unknown" ], "type": "string" }, "DiscoveryAwsEksCluster": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsEksClusterAnalysis" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEksEncryptionStatus" }, "kms_key_id": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/DiscoveryAwsEksClusterStatus" } }, "required": ["name", "encryption_status", "status", "analysis"], "type": "object" } ] }, "DiscoveryAwsEksClusterAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsEksClusterStatus": { "enum": [ "active", "creating", "deleting", "failed", "pending", "updating", "unknown" ], "type": "string" }, "DiscoveryAwsEksEncryptionStatus": { "enum": ["encrypted", "unencrypted"], "type": "string" }, "DiscoveryAwsEncryptionStatus": { "enum": [ "unencrypted", "encrypted_with_csp_generated_key", "encrypted_with_platform_managed_key", "encrypted_with_customer_managed_key" ], "type": "string" }, "DiscoveryAwsFilterMetadata": { "allOf": [ { "properties": { "account_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "region_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" } }, "required": ["account_metrics", "region_metrics"], "type": "object" } ] }, "DiscoveryAwsKeyUsageDetails": { "allOf": [ { "properties": { "key": { "$ref": "#/components/schemas/DiscoveryAwsObject" }, "key_id": { "type": "string" }, "protected_services": { "items": { "$ref": "#/components/schemas/DiscoveryAwsObject" }, "type": "array" } }, "required": ["key_id", "key", "protected_services"], "type": "object" } ] }, "DiscoveryAwsKeyUsageParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryAwsKeyUsageResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryAwsKeyUsageDetails" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryAwsKeysAssessment": { "allOf": [ { "properties": { "count_by_origin": { "additionalProperties": { "type": "integer" }, "type": "object" }, "overly_permissive_key_management": { "type": "integer" }, "overly_permissive_key_usage": { "type": "integer" }, "pending_deletion_keys": { "type": "integer" }, "pending_expiration_keys": { "type": "integer" }, "quantum_vulnerable_keys": { "type": "integer" }, "total_keys": { "type": "integer" } }, "required": [ "total_keys", "count_by_origin", "pending_deletion_keys", "pending_expiration_keys", "quantum_vulnerable_keys", "overly_permissive_key_usage", "overly_permissive_key_management" ], "type": "object" } ] }, "DiscoveryAwsKmsExternalKeyStore": { "allOf": [ { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "type": "object" } ] }, "DiscoveryAwsKmsKey": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyAnalysis" }, "external_key_stores": { "items": { "$ref": "#/components/schemas/DiscoveryAwsKmsExternalKeyStore" }, "nullable": true, "type": "array" }, "key_aliases": { "items": { "type": "string" }, "type": "array" }, "key_creation_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "key_id": { "nullable": true, "type": "string" }, "key_manager": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyManager" }, "key_origin": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyOrigin" }, "key_rotation_status": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyRotationStatus" }, "key_spec": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeySpec" }, "key_state": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyState" }, "key_tags": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "key_usage": { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyUsage" }, "key_valid_to": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "last_rotated_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "source_scan_inventory_object": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectReference" } }, "required": ["key_aliases", "analysis"], "type": "object" } ] }, "DiscoveryAwsKmsKeyAnalysis": { "allOf": [ { "properties": { "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryAwsCryptoPolicyCompliance" }, "is_cross_account_key": { "nullable": true, "type": "boolean" }, "is_shared": { "type": "boolean" }, "overly_permissive_violations": { "$ref": "#/components/schemas/DiscoveryOverlyPermissiveViolations" }, "usage_details": { "$ref": "#/components/schemas/DiscoveryKeyUsageDetails" }, "usages": { "items": { "$ref": "#/components/schemas/DiscoveryKeyUsage" }, "nullable": true, "type": "array", "uniqueItems": true } }, "required": ["is_shared"], "type": "object" } ] }, "DiscoveryAwsKmsKeyManager": { "enum": ["aws", "customer", "other"], "type": "string" }, "DiscoveryAwsKmsKeyOrigin": { "enum": ["kms", "imported", "cloud_hsm", "xks", "fortanix", "other"], "type": "string" }, "DiscoveryAwsKmsKeyRotationStatus": { "discriminator": { "mapping": { "disabled": "DiscoveryAwsKmsKeyRotationStatusVariantDisabled", "enabled": "DiscoveryAwsKmsKeyRotationStatusVariantEnabled", "unknown": "DiscoveryAwsKmsKeyRotationStatusVariantUnknown" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyRotationStatusVariantUnknown" }, { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyRotationStatusVariantEnabled" }, { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyRotationStatusVariantDisabled" } ] }, "DiscoveryAwsKmsKeyRotationStatusEnabled": { "allOf": [ { "properties": { "next_rotation_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "rotation_period": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["next_rotation_date", "rotation_period"], "type": "object" } ] }, "DiscoveryAwsKmsKeyRotationStatusVariantDisabled": { "allOf": [ { "properties": { "$type": { "enum": ["disabled"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAwsKmsKeyRotationStatusVariantEnabled": { "allOf": [ { "properties": { "$type": { "enum": ["enabled"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsKmsKeyRotationStatusEnabled" } ] }, "DiscoveryAwsKmsKeyRotationStatusVariantUnknown": { "allOf": [ { "properties": { "$type": { "enum": ["unknown"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAwsKmsKeySpec": { "enum": [ "rsa2048", "rsa3072", "rsa4096", "ecc_nist_p256", "ecc_nist_p384", "ecc_nist_p521", "ecc_secg_p256k1", "symmetric_default", "hmac224", "hmac256", "hmac384", "hmac512", "sm2", "other" ], "type": "string" }, "DiscoveryAwsKmsKeyState": { "enum": [ "creating", "enabled", "disabled", "pending_deletion", "pending_import", "pending_replica_deletion", "unavailable", "updating", "other" ], "type": "string" }, "DiscoveryAwsKmsKeyUsage": { "enum": [ "sign_verify", "encrypt_decrypt", "generate_verify_mac", "other" ], "type": "string" }, "DiscoveryAwsObject": { "allOf": [ { "properties": { "account": { "$ref": "#/components/schemas/DiscoveryAwsAccount" }, "arn": { "type": "string" }, "details": { "$ref": "#/components/schemas/DiscoveryAwsObjectDetails" }, "region": { "$ref": "#/components/schemas/DiscoveryAwsRegion" } }, "required": ["arn", "region", "account", "details"], "type": "object" } ] }, "DiscoveryAwsObjectDetails": { "discriminator": { "mapping": { "acm": "DiscoveryAwsObjectDetailsVariantAcm", "dynamo_db": "DiscoveryAwsObjectDetailsVariantDynamoDb", "ebs": "DiscoveryAwsObjectDetailsVariantEbs", "efs": "DiscoveryAwsObjectDetailsVariantEfs", "eks": "DiscoveryAwsObjectDetailsVariantEks", "kms": "DiscoveryAwsObjectDetailsVariantKms", "rds": "DiscoveryAwsObjectDetailsVariantRds", "redshift": "DiscoveryAwsObjectDetailsVariantRedshift", "s3": "DiscoveryAwsObjectDetailsVariantS3" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantAcm" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantEbs" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantKms" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantS3" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantRds" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantDynamoDb" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantEks" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantEfs" }, { "$ref": "#/components/schemas/DiscoveryAwsObjectDetailsVariantRedshift" } ] }, "DiscoveryAwsObjectDetailsVariantAcm": { "allOf": [ { "properties": { "$type": { "enum": ["acm"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAcmCertificate" } ] }, "DiscoveryAwsObjectDetailsVariantDynamoDb": { "allOf": [ { "properties": { "$type": { "enum": ["dynamo_db"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsDynamoDbInstance" } ] }, "DiscoveryAwsObjectDetailsVariantEbs": { "allOf": [ { "properties": { "$type": { "enum": ["ebs"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsEbsVolume" } ] }, "DiscoveryAwsObjectDetailsVariantEfs": { "allOf": [ { "properties": { "$type": { "enum": ["efs"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsEfsFileSystem" } ] }, "DiscoveryAwsObjectDetailsVariantEks": { "allOf": [ { "properties": { "$type": { "enum": ["eks"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsEksCluster" } ] }, "DiscoveryAwsObjectDetailsVariantKms": { "allOf": [ { "properties": { "$type": { "enum": ["kms"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsKmsKey" } ] }, "DiscoveryAwsObjectDetailsVariantRds": { "allOf": [ { "properties": { "$type": { "enum": ["rds"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsRdsDbInstance" } ] }, "DiscoveryAwsObjectDetailsVariantRedshift": { "allOf": [ { "properties": { "$type": { "enum": ["redshift"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsRedshiftCluster" } ] }, "DiscoveryAwsObjectDetailsVariantS3": { "allOf": [ { "properties": { "$type": { "enum": ["s3"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsS3Bucket" } ] }, "DiscoveryAwsProtectedServicesCount": { "allOf": [ { "properties": { "encrypted_services": { "type": "integer" }, "total_services": { "type": "integer" } }, "required": ["total_services", "encrypted_services"], "type": "object" } ] }, "DiscoveryAwsRdsDbInstance": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsRdsDbInstanceAnalysis" }, "engine": { "nullable": true, "type": "string" }, "engine_version": { "nullable": true, "type": "string" }, "identifier": { "nullable": true, "type": "string" }, "kms_key_id": { "nullable": true, "type": "string" } }, "required": ["analysis"], "type": "object" } ] }, "DiscoveryAwsRdsDbInstanceAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsRedshiftCluster": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsRedshiftClusterAnalysis" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsRedshiftEncryptionStatus" }, "kms_key_id": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/DiscoveryAwsRedshiftClusterStatus" } }, "required": ["name", "encryption_status", "status", "analysis"], "type": "object" } ] }, "DiscoveryAwsRedshiftClusterAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": [ "encrypted_with_noncompliant_key", "encrypted_with_overly_permissive_usage_key", "encrypted_with_overly_permissive_management_key", "encrypted_with_shared_key" ], "type": "object" } ] }, "DiscoveryAwsRedshiftClusterStatus": { "enum": [ "available", "available_prep_for_resize", "available_resize_cleanup", "canceling_resize", "creating", "deleting", "final_snapshot", "hardware_failure", "incompatible_hsm", "incompatible_network", "incompatible_parameters", "incompatible_restore", "modifying", "paused", "rebooting", "renaming", "resizing", "rotating_keys", "storage_full", "updating_hsm", "pausing", "resuming", "restoring", "unknown" ], "type": "string" }, "DiscoveryAwsRedshiftEncryptionStatus": { "enum": ["encrypted", "unencrypted"], "type": "string" }, "DiscoveryAwsRegion": { "description": "Reference: https://docs.aws.amazon.com/general/latest/gr/rande.html", "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-3", "ap-southeast-4", "ap-south-1", "ap-northeast-3", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "ca-west-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-south-1", "eu-west-3", "eu-south-2", "eu-north-1", "eu-central-2", "il-central-1", "me-south-1", "me-central-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1" ], "type": "string" }, "DiscoveryAwsRegionViolationMetrics": { "allOf": [ { "properties": { "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations_by_service_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryServiceViolationMetricsWithOverallRisk" }, "type": "object" } }, "required": ["overall_risk", "violations_by_service_type"], "type": "object" } ] }, "DiscoveryAwsRiskAssessment": { "allOf": [ { "properties": { "findings": { "additionalProperties": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" }, "type": "object" }, "type": "object" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["findings", "overall_risk"], "type": "object" } ] }, "DiscoveryAwsS3Bucket": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAwsS3BucketAnalysis" }, "name": { "type": "string" }, "server_side_encryption_rules": { "items": { "$ref": "#/components/schemas/DiscoveryAwsServerSideEncryptionRule" }, "type": "array" } }, "required": ["name", "server_side_encryption_rules", "analysis"], "type": "object" } ] }, "DiscoveryAwsS3BucketAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "encryption_status": { "$ref": "#/components/schemas/DiscoveryAwsEncryptionStatus" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAwsScanAssessmentReport": { "allOf": [ { "properties": { "certificate_assessment": { "$ref": "#/components/schemas/DiscoveryAwsCertificateAssessment" }, "keys_assessment": { "$ref": "#/components/schemas/DiscoveryAwsKeysAssessment" }, "risk_assessment": { "$ref": "#/components/schemas/DiscoveryAwsRiskAssessment" }, "security_issues": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" }, "violations_by_service": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" }, "type": "object" } }, "required": [ "violations_by_service", "security_issues", "risk_assessment" ], "type": "object" } ] }, "DiscoveryAwsScannedServicesReportByAccountParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryAwsScannedServicesResponseByAccount": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryAwsAccountViolationMetrics" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryAwsServicesReportMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoveryAwsScope": { "description": "The scope that current AWS credentials should have access to", "discriminator": { "mapping": { "account": "DiscoveryAwsScopeVariantAccount", "organization": "DiscoveryAwsScopeVariantOrganization" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAwsScopeVariantAccount" }, { "$ref": "#/components/schemas/DiscoveryAwsScopeVariantOrganization" } ] }, "DiscoveryAwsScopeAccount": { "allOf": [ { "properties": { "account_id": { "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryAwsScopeVariantAccount": { "allOf": [ { "properties": { "$type": { "enum": ["account"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsScopeAccount" } ] }, "DiscoveryAwsScopeVariantOrganization": { "allOf": [ { "properties": { "$type": { "enum": ["organization"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAwsServerSideEncryptionRule": { "allOf": [ { "properties": { "bucket_key_enabled": { "type": "boolean" }, "default_sse": { "$ref": "#/components/schemas/DiscoveryAwsDefaultServerSideEncryption" } }, "required": ["bucket_key_enabled"], "type": "object" } ] }, "DiscoveryAwsService": { "enum": [ "acm", "ebs", "kms", "s3", "rds", "dynamo_db", "eks", "efs", "redshift" ], "type": "string" }, "DiscoveryAwsServicesReportMetadata": { "allOf": [ { "properties": { "account_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "region_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "violation_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" } }, "required": [ "violation_metrics", "resource_metrics", "region_metrics", "account_metrics" ], "type": "object" } ] }, "DiscoveryAwsSseAlgorithm": { "enum": ["aes256", "kms", "aws:kms_dsse", "other"], "type": "string" }, "DiscoveryAwsSummaryData": { "allOf": [ { "properties": { "certificate_count_by_algorithm": { "additionalProperties": { "type": "integer" }, "nullable": true, "type": "object" }, "certificate_count_by_status": { "additionalProperties": { "type": "integer" }, "nullable": true, "type": "object" }, "cloud_discovery": { "$ref": "#/components/schemas/DiscoveryAwsCloudDiscoveryData" }, "key_source": { "additionalProperties": { "type": "integer" }, "type": "object" }, "key_status": { "additionalProperties": { "type": "integer" }, "type": "object" }, "key_types": { "additionalProperties": { "type": "integer" }, "type": "object" }, "protected_services": { "$ref": "#/components/schemas/DiscoveryAwsProtectedServicesCount" }, "top_accounts": { "items": { "$ref": "#/components/schemas/DiscoveryAwsAccountKeysCount" }, "type": "array" } }, "required": [ "top_accounts", "key_status", "key_types", "key_source" ], "type": "object" } ] }, "DiscoveryAzureCloudDiscoveryData": { "allOf": [ { "properties": { "total_keys": { "type": "integer" }, "total_regions": { "type": "integer" }, "total_resource_groups": { "type": "integer" }, "total_services": { "type": "integer" }, "total_subscriptions": { "type": "integer" } }, "required": [ "total_subscriptions", "total_resource_groups", "total_regions", "total_keys", "total_services" ], "type": "object" } ] }, "DiscoveryAzureConfig": { "allOf": [ { "properties": { "azure_scope": { "$ref": "#/components/schemas/DiscoveryAzureScope" }, "credentials": { "$ref": "#/components/schemas/DiscoveryAzureCredentials" }, "tenant_id": { "format": "uuid", "type": "string" } }, "required": ["credentials", "azure_scope", "tenant_id"], "type": "object" } ] }, "DiscoveryAzureContainerGroup": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureContainerGroupAnalysis" }, "encryption_source": { "$ref": "#/components/schemas/DiscoveryAzureContainerGroupEncryptionSource" }, "name": { "type": "string" } }, "required": ["name", "encryption_source", "analysis"], "type": "object" } ] }, "DiscoveryAzureContainerGroupAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_exportable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": [ "encrypted_with_noncompliant_key", "encrypted_with_overly_permissive_usage_key", "encrypted_with_overly_permissive_management_key", "key_availability", "encrypted_with_shared_key" ], "type": "object" } ] }, "DiscoveryAzureContainerGroupEncryptionSource": { "discriminator": { "mapping": { "customer_managed_key": "DiscoveryAzureContainerGroupEncryptionSourceVariantCustomerManagedKey", "microsoft_managed_key": "DiscoveryAzureContainerGroupEncryptionSourceVariantMicrosoftManagedKey" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureContainerGroupEncryptionSourceVariantMicrosoftManagedKey" }, { "$ref": "#/components/schemas/DiscoveryAzureContainerGroupEncryptionSourceVariantCustomerManagedKey" } ] }, "DiscoveryAzureContainerGroupEncryptionSourceCustomerManagedKey": { "allOf": [ { "properties": { "key_id": { "type": "string" } }, "required": ["key_id"], "type": "object" } ] }, "DiscoveryAzureContainerGroupEncryptionSourceVariantCustomerManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["customer_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureContainerGroupEncryptionSourceCustomerManagedKey" } ] }, "DiscoveryAzureContainerGroupEncryptionSourceVariantMicrosoftManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["microsoft_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureCredentials": { "discriminator": { "mapping": { "client_id_and_secret": "DiscoveryAzureCredentialsVariantClientIdAndSecret", "open_id_connect": "DiscoveryAzureCredentialsVariantOpenIdConnect" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureCredentialsVariantClientIdAndSecret" }, { "$ref": "#/components/schemas/DiscoveryAzureCredentialsVariantOpenIdConnect" } ] }, "DiscoveryAzureCredentialsClientIdAndSecret": { "allOf": [ { "properties": { "client_id": { "type": "string" }, "client_secret": { "nullable": true, "type": "string" } }, "required": ["client_id"], "type": "object" } ] }, "DiscoveryAzureCredentialsOpenIdConnect": { "allOf": [ { "properties": { "auth_config_id": { "description": "Uuid for the AuthConfig object within Account", "format": "uuid", "type": "string" }, "client_id": { "type": "string" } }, "required": ["client_id", "auth_config_id"], "type": "object" } ] }, "DiscoveryAzureCredentialsVariantClientIdAndSecret": { "allOf": [ { "properties": { "$type": { "enum": ["client_id_and_secret"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureCredentialsClientIdAndSecret" } ] }, "DiscoveryAzureCredentialsVariantOpenIdConnect": { "allOf": [ { "properties": { "$type": { "enum": ["open_id_connect"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureCredentialsOpenIdConnect" } ] }, "DiscoveryAzureCryptoPolicyCompliance": { "allOf": [ { "properties": { "is_compliant": { "description": "Represents if the crypto policy is compliant for the key.", "type": "boolean" }, "violation_reason": { "description": "Represents the violation reason if the non-compliant against the\ncrypto policy, otherwise `None`.", "nullable": true, "type": "string" } }, "required": ["is_compliant"], "type": "object" } ] }, "DiscoveryAzureDatabaseAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_exportable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAzureDatabaseDeployment": { "discriminator": { "mapping": { "cosmos_db": "DiscoveryAzureDatabaseDeploymentVariantCosmosDb", "sql_managed_instance": "DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstance", "sql_managed_instance_pool": "DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstancePool", "sql_single_server": "DiscoveryAzureDatabaseDeploymentVariantSqlSingleServer" }, "propertyName": "$db_variant" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentVariantSqlSingleServer" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstance" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstancePool" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentVariantCosmosDb" } ] }, "DiscoveryAzureDatabaseDeploymentCosmosDb": { "allOf": [ { "properties": { "api": { "description": "The API a Cosmos databases exposes to applications.\nSome possible values currently available in Azure are\n\"Sql\", \"MongoDB\", \"Cassandra\", ...\nThis may be directly exposed in the frontend.", "type": "string" }, "properties": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentProperties" } }, "required": ["api", "properties"], "type": "object" } ] }, "DiscoveryAzureDatabaseDeploymentProperties": { "allOf": [ { "properties": { "deployment_name": { "type": "string" }, "encryption_details": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionDetails" }, "inner_databases_properties": { "items": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseProperties" }, "type": "array" } }, "required": [ "deployment_name", "inner_databases_properties", "encryption_details" ], "type": "object" } ] }, "DiscoveryAzureDatabaseDeploymentSqlManagedInstance": { "allOf": [ { "properties": { "properties": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentProperties" } }, "required": ["properties"], "type": "object" } ] }, "DiscoveryAzureDatabaseDeploymentSqlManagedInstancePool": { "allOf": [ { "properties": { "properties": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentProperties" } }, "required": ["properties"], "type": "object" } ] }, "DiscoveryAzureDatabaseDeploymentSqlSingleServer": { "allOf": [ { "properties": { "properties": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentProperties" }, "tier": { "$ref": "#/components/schemas/DiscoveryAzureSqlSingleServerTier" } }, "required": ["tier", "properties"], "type": "object" } ] }, "DiscoveryAzureDatabaseDeploymentVariantCosmosDb": { "allOf": [ { "properties": { "$db_variant": { "enum": ["cosmos_db"], "type": "string" } }, "required": ["$db_variant"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentCosmosDb" } ] }, "DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstance": { "allOf": [ { "properties": { "$db_variant": { "enum": ["sql_managed_instance"], "type": "string" } }, "required": ["$db_variant"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentSqlManagedInstance" } ] }, "DiscoveryAzureDatabaseDeploymentVariantSqlManagedInstancePool": { "allOf": [ { "properties": { "$db_variant": { "enum": ["sql_managed_instance_pool"], "type": "string" } }, "required": ["$db_variant"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentSqlManagedInstancePool" } ] }, "DiscoveryAzureDatabaseDeploymentVariantSqlSingleServer": { "allOf": [ { "properties": { "$db_variant": { "enum": ["sql_single_server"], "type": "string" } }, "required": ["$db_variant"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeploymentSqlSingleServer" } ] }, "DiscoveryAzureDatabaseEncryptionDetails": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseAnalysis" }, "key_source": { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySource" } }, "required": ["key_source", "analysis"], "type": "object" } ] }, "DiscoveryAzureDatabaseEncryptionKeySource": { "description": "Specifier for optional CMK Keys.", "discriminator": { "mapping": { "database_level_customer_managed_key": "DiscoveryAzureDatabaseEncryptionKeySourceVariantDatabaseLevelCustomerManagedKey", "deployment_level_customer_managed_key": "DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelCustomerManagedKey", "deployment_level_microsoft_managed_key": "DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelMicrosoftManagedKey" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelCustomerManagedKey" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelMicrosoftManagedKey" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySourceVariantDatabaseLevelCustomerManagedKey" } ] }, "DiscoveryAzureDatabaseEncryptionKeySourceDatabaseLevelCustomerManagedKey": { "allOf": [ { "properties": { "key_id": { "type": "string" } }, "required": ["key_id"], "type": "object" } ] }, "DiscoveryAzureDatabaseEncryptionKeySourceDeploymentLevelCustomerManagedKey": { "allOf": [ { "properties": { "key_id": { "type": "string" } }, "required": ["key_id"], "type": "object" } ] }, "DiscoveryAzureDatabaseEncryptionKeySourceVariantDatabaseLevelCustomerManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["database_level_customer_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySourceDatabaseLevelCustomerManagedKey" } ] }, "DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelCustomerManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["deployment_level_customer_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseEncryptionKeySourceDeploymentLevelCustomerManagedKey" } ] }, "DiscoveryAzureDatabaseEncryptionKeySourceVariantDeploymentLevelMicrosoftManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["deployment_level_microsoft_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureDatabaseProperties": { "allOf": [ { "properties": { "database_name": { "type": "string" }, "is_tde_enabled": { "description": "If true, encryption is in place either with a CMK (customer managed key)\nor MMK (microsoft managed key).", "type": "boolean" } }, "required": ["database_name", "is_tde_enabled"], "type": "object" } ] }, "DiscoveryAzureDiskInstanceAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_exportable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAzureDiskState": { "description": "Used to represent state of [AzureManagedDisk]. for reference:\n[Documentation](https://learn.microsoft.com/en-us/rest/api/compute/disks/list-by-resource-group?view=rest-compute-2024-03-01&tabs=HTTP#diskstate)", "enum": [ "active_sas", "active_sas_frozen", "active_upload", "attached", "frozen", "ready_to_upload", "reserved", "unattached", "other" ], "type": "string" }, "DiscoveryAzureDiskType": { "description": "Used to represent SKU of [AzureManagedDisk]. For reference:\n[Documentation](https://learn.microsoft.com/en-us/rest/api/compute/disks/list-by-resource-group?view=rest-compute-2024-03-01&tabs=HTTP#diskstate)", "enum": [ "premium_v2_lrs", "premium_lrs", "premium_zrs", "standard_ssd_lrs", "standard_ssd_zrs", "standard_lrs", "ultra_ssd_lrs" ], "type": "string" }, "DiscoveryAzureEncryptionSettings": { "allOf": [ { "properties": { "key_source": { "$ref": "#/components/schemas/DiscoveryAzureStorageKeySource" } }, "required": ["key_source"], "type": "object" } ] }, "DiscoveryAzureFilterMetadata": { "allOf": [ { "properties": { "region_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "resource_group_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "subscription_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" } }, "required": [ "subscription_metrics", "resource_group_metrics", "region_metrics" ], "type": "object" } ] }, "DiscoveryAzureKeyAvailability": { "discriminator": { "mapping": { "available": "DiscoveryAzureKeyAvailabilityVariantAvailable", "soft_deleted": "DiscoveryAzureKeyAvailabilityVariantSoftDeleted" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureKeyAvailabilityVariantAvailable" }, { "$ref": "#/components/schemas/DiscoveryAzureKeyAvailabilityVariantSoftDeleted" } ] }, "DiscoveryAzureKeyAvailabilitySoftDeleted": { "allOf": [ { "properties": { "deleted_on": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "scheduled_purge_on": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" } }, "required": ["deleted_on"], "type": "object" } ] }, "DiscoveryAzureKeyAvailabilityVariantAvailable": { "allOf": [ { "properties": { "$type": { "enum": ["available"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureKeyAvailabilityVariantSoftDeleted": { "allOf": [ { "properties": { "$type": { "enum": ["soft_deleted"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureKeyAvailabilitySoftDeleted" } ] }, "DiscoveryAzureKeyCountByStatus": { "allOf": [ { "properties": { "auto_rotation_disabled": { "description": "The total number of keys whose autorotation is not enabled.", "type": "integer" }, "customer_managed_keys": { "description": "The total number of customer managed keys", "nullable": true, "type": "integer" }, "enabled_keys": { "description": "The total number of keys that are enabled.", "nullable": true, "type": "integer" }, "not_activated": { "description": "The total number of keys that are not activated.", "type": "integer" }, "platform_managed_keys": { "description": "The total number of platform managed keys", "nullable": true, "type": "integer" }, "shared": { "description": "The total number of keys that are shared.", "type": "integer" } }, "required": ["shared", "auto_rotation_disabled", "not_activated"], "type": "object" } ] }, "DiscoveryAzureKeySource": { "enum": ["kv", "fortanix", "other"], "type": "string" }, "DiscoveryAzureKeyUsageDetails": { "allOf": [ { "properties": { "key": { "$ref": "#/components/schemas/DiscoveryAzureObject" }, "key_id": { "type": "string" }, "protected_services": { "items": { "$ref": "#/components/schemas/DiscoveryAzureObject" }, "type": "array" } }, "required": ["key_id", "key", "protected_services"], "type": "object" } ] }, "DiscoveryAzureKeyUsageParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryAzureKeyUsageResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryAzureKeyUsageDetails" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryAzureKvAccessTier": { "enum": ["standard", "premium"], "type": "string" }, "DiscoveryAzureKvKeyAnalysis": { "allOf": [ { "properties": { "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryAzureCryptoPolicyCompliance" }, "is_shared": { "description": "Defaults to `false`. Will be `true` only if underlying key is used\nto encrypt multiple services.", "type": "boolean" }, "overly_permissive_key_violations": { "$ref": "#/components/schemas/DiscoveryAzureOverlyPermissiveKeyViolations" }, "usage_details": { "$ref": "#/components/schemas/DiscoveryKeyUsageDetails" }, "usages": { "items": { "$ref": "#/components/schemas/DiscoveryKeyUsage" }, "nullable": true, "type": "array", "uniqueItems": true } }, "required": ["is_shared"], "type": "object" } ] }, "DiscoveryAzureKvKeyAttributes": { "allOf": [ { "properties": { "activation_date": { "description": "The timestamp when the key will be activated. None,\nif the activation date is not set for the key.", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "created_at": { "description": "The timestamp of creation of the key.", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "expiry_date": { "description": "The timestamp when the key will expire. None, if the expiry date is\nnot scheduled for the key.", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "is_enabled": { "description": "Represents true if the key is enabled, false otherwise.", "type": "boolean" }, "is_exportable": { "description": "Represents true if the key is exportable, false otherwise.", "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryAzureKeyAvailability" }, "recoverable_days": { "description": "Soft Delete data retention days. Value should be >=7 and <=90 when\nsoft delete is enabled, otherwise 0.", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "recovery_level": { "$ref": "#/components/schemas/DiscoveryAzureKvRecoveryLevel" }, "updated_at": { "description": "The timestamp when the key was last updated. By default, it will\nalways have the key creation timestamp as the last updated time.", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" } }, "required": [ "created_at", "updated_at", "recoverable_days", "recovery_level", "is_exportable", "is_enabled" ], "type": "object" } ] }, "DiscoveryAzureKvKeyOperation": { "enum": [ "encrypt", "decrypt", "sign", "verify", "wrap_key", "unwrap_key", "import" ], "type": "string" }, "DiscoveryAzureKvKeyPolicyInfo": { "allOf": [ { "properties": { "principal_id": { "type": "string" }, "role_assignment_id": { "type": "string" }, "role_definition_id": { "type": "string" } }, "required": [ "principal_id", "role_definition_id", "role_assignment_id" ], "type": "object" } ] }, "DiscoveryAzureKvKeyType": { "enum": [ "rsa2048", "rsa3072", "rsa4096", "rsa_hsm2048", "rsa_hsm3072", "rsa_hsm4096", "ecc_nist_p256", "ecc_nist_p384", "ecc_nist_p521", "ecc_secg_p256k1", "ecc_nist_hsm_p256", "ecc_nist_hsm_p384", "ecc_nist_hsm_p521", "ecc_secg_hsm_p256k1", "oct", "oct_hsm", "unknown" ], "type": "string" }, "DiscoveryAzureKvKeyVersion": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyAnalysis" }, "is_current_version": { "description": "True if this is the latest key version, False otherwise.", "type": "boolean" }, "is_key_managed": { "description": "True if the key version's lifetime is managed by key vault,\nFalse otherwise.", "type": "boolean" }, "key_attributes": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyAttributes" }, "key_name": { "description": "The name associated with the key version.", "type": "string" }, "key_ops": { "description": "Allowed key operations on the key version.", "items": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyOperation" }, "type": "array" }, "key_rotation_date": { "description": "Returns the date when the key will be rotated. None, when the auto\nkey rotation is not enabled for the key.", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "key_source": { "$ref": "#/components/schemas/DiscoveryAzureKeySource" }, "key_type": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyType" }, "key_vault_access_tier": { "$ref": "#/components/schemas/DiscoveryAzureKvAccessTier" }, "key_vault_name": { "description": "Represents the Azure Key Vault Name.", "type": "string" }, "key_vault_uri": { "description": "Represents the Azure key vault URI.", "type": "string" }, "key_version": { "description": "The key version of the scanned key.", "type": "string" }, "source_scan_inventory_object": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectReference" }, "tags": { "additionalProperties": { "type": "string" }, "description": "The tags associated with the key version.", "type": "object" } }, "required": [ "key_name", "key_version", "is_current_version", "key_vault_uri", "key_vault_name", "key_vault_access_tier", "key_attributes", "key_type", "key_ops", "tags", "is_key_managed", "analysis" ], "type": "object" } ] }, "DiscoveryAzureKvRecoveryLevel": { "enum": [ "customized_recoverable", "customized_recoverable_and_protected_subscription", "customized_recoverable_and_purgeable", "purgeable", "recoverable", "recoverable_and_protected_subscription", "recoverable_and_purgeable", "unknown" ], "type": "string" }, "DiscoveryAzureManagedCluster": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureManagedClusterAnalysis" }, "disk_encryption_details": { "$ref": "#/components/schemas/DiscoveryAzureManagedClusterDiskEncryptionDetails" }, "name": { "type": "string" } }, "required": ["name", "disk_encryption_details", "analysis"], "type": "object" } ] }, "DiscoveryAzureManagedClusterAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_exportable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": [ "encrypted_with_noncompliant_key", "encrypted_with_overly_permissive_usage_key", "encrypted_with_overly_permissive_management_key", "key_availability", "encrypted_with_shared_key" ], "type": "object" } ] }, "DiscoveryAzureManagedClusterDiskEncryptionDetails": { "discriminator": { "mapping": { "encryption_at_rest_with_customer_key": "DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithCustomerKey", "encryption_at_rest_with_platform_key": "DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithPlatformKey" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithCustomerKey" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithPlatformKey" } ] }, "DiscoveryAzureManagedClusterDiskEncryptionDetailsEncryptionAtRestWithCustomerKey": { "allOf": [ { "properties": { "key_id": { "type": "string" }, "key_rotation_enabled": { "type": "boolean" } }, "required": ["key_id", "key_rotation_enabled"], "type": "object" } ] }, "DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithCustomerKey": { "allOf": [ { "properties": { "$type": { "enum": ["encryption_at_rest_with_customer_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedClusterDiskEncryptionDetailsEncryptionAtRestWithCustomerKey" } ] }, "DiscoveryAzureManagedClusterDiskEncryptionDetailsVariantEncryptionAtRestWithPlatformKey": { "allOf": [ { "properties": { "$type": { "enum": ["encryption_at_rest_with_platform_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureManagedDisk": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureDiskInstanceAnalysis" }, "disk_size_gb": { "format": "int32", "type": "integer" }, "disk_state": { "$ref": "#/components/schemas/DiscoveryAzureDiskState" }, "disk_type": { "$ref": "#/components/schemas/DiscoveryAzureDiskType" }, "encryption_settings": { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettings" }, "name": { "type": "string" } }, "required": [ "name", "disk_size_gb", "disk_state", "disk_type", "encryption_settings", "analysis" ], "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettings": { "description": "Used to describe [Server-side encryption][1] configuration of [AzureManagedDisks]\n- This does not cover [Azure Disk Encryption][2] which is handled on a volume level on VM\n\n[1]: https://learn.microsoft.com/en-us/azure/virtual-machines/disk-encryption\n[2]: https://learn.microsoft.com/en-us/azure/virtual-machines/linux/disk-encryption-overview", "discriminator": { "mapping": { "confidential_vm_encrypted_with_azure_managed_key": "DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithAzureManagedKey", "confidential_vm_encrypted_with_customer_key": "DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithCustomerKey", "encryption_at_rest_with_azure_and_customer_keys": "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureAndCustomerKeys", "encryption_at_rest_with_azure_managed_key": "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureManagedKey", "encryption_at_rest_with_customer_key": "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithCustomerKey" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureManagedKey" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithAzureManagedKey" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithCustomerKey" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithCustomerKey" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureAndCustomerKeys" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsConfidentialVmEncryptedWithCustomerKey": { "allOf": [ { "properties": { "key_id": { "type": "string" }, "key_rotation_enabled": { "type": "boolean" } }, "required": ["key_id", "key_rotation_enabled"], "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsEncryptionAtRestWithAzureAndCustomerKeys": { "allOf": [ { "properties": { "key_id": { "type": "string" }, "key_rotation_enabled": { "type": "boolean" } }, "required": ["key_id", "key_rotation_enabled"], "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsEncryptionAtRestWithCustomerKey": { "allOf": [ { "properties": { "key_id": { "type": "string" }, "key_rotation_enabled": { "type": "boolean" } }, "required": ["key_id", "key_rotation_enabled"], "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithAzureManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["confidential_vm_encrypted_with_azure_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsVariantConfidentialVmEncryptedWithCustomerKey": { "allOf": [ { "properties": { "$type": { "enum": ["confidential_vm_encrypted_with_customer_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsConfidentialVmEncryptedWithCustomerKey" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureAndCustomerKeys": { "allOf": [ { "properties": { "$type": { "enum": ["encryption_at_rest_with_azure_and_customer_keys"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsEncryptionAtRestWithAzureAndCustomerKeys" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithAzureManagedKey": { "allOf": [ { "properties": { "$type": { "enum": ["encryption_at_rest_with_azure_managed_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureManagedDiskEncryptionSettingsVariantEncryptionAtRestWithCustomerKey": { "allOf": [ { "properties": { "$type": { "enum": ["encryption_at_rest_with_customer_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDiskEncryptionSettingsEncryptionAtRestWithCustomerKey" } ] }, "DiscoveryAzureObject": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryAzureObjectDetails" }, "region": { "$ref": "#/components/schemas/DiscoveryAzureRegion" }, "resource_group": { "$ref": "#/components/schemas/DiscoveryAzureResourceGroup" }, "resource_id": { "type": "string" }, "subscription": { "$ref": "#/components/schemas/DiscoveryAzureSubscription" } }, "required": [ "resource_id", "region", "subscription", "resource_group", "details" ], "type": "object" } ] }, "DiscoveryAzureObjectDetails": { "discriminator": { "mapping": { "container_group": "DiscoveryAzureObjectDetailsVariantContainerGroup", "database": "DiscoveryAzureObjectDetailsVariantDatabase", "kv_key_version": "DiscoveryAzureObjectDetailsVariantKvKeyVersion", "managed_cluster": "DiscoveryAzureObjectDetailsVariantManagedCluster", "managed_disk": "DiscoveryAzureObjectDetailsVariantManagedDisk", "storage_account": "DiscoveryAzureObjectDetailsVariantStorageAccount", "storage_account_blob": "DiscoveryAzureObjectDetailsVariantStorageAccountBlob" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantDatabase" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantKvKeyVersion" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantStorageAccount" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantContainerGroup" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantManagedDisk" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantManagedCluster" }, { "$ref": "#/components/schemas/DiscoveryAzureObjectDetailsVariantStorageAccountBlob" } ] }, "DiscoveryAzureObjectDetailsVariantContainerGroup": { "allOf": [ { "properties": { "$type": { "enum": ["container_group"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureContainerGroup" } ] }, "DiscoveryAzureObjectDetailsVariantDatabase": { "allOf": [ { "properties": { "$type": { "enum": ["database"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureDatabaseDeployment" } ] }, "DiscoveryAzureObjectDetailsVariantKvKeyVersion": { "allOf": [ { "properties": { "$type": { "enum": ["kv_key_version"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureKvKeyVersion" } ] }, "DiscoveryAzureObjectDetailsVariantManagedCluster": { "allOf": [ { "properties": { "$type": { "enum": ["managed_cluster"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedCluster" } ] }, "DiscoveryAzureObjectDetailsVariantManagedDisk": { "allOf": [ { "properties": { "$type": { "enum": ["managed_disk"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureManagedDisk" } ] }, "DiscoveryAzureObjectDetailsVariantStorageAccount": { "allOf": [ { "properties": { "$type": { "enum": ["storage_account"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureStorageAccount" } ] }, "DiscoveryAzureObjectDetailsVariantStorageAccountBlob": { "allOf": [ { "properties": { "$type": { "enum": ["storage_account_blob"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureStorageAccountBlob" } ] }, "DiscoveryAzureOverlyPermissiveKeyViolations": { "allOf": [ { "properties": { "management_violations": { "items": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyPolicyInfo" }, "type": "array" }, "usage_violations": { "items": { "$ref": "#/components/schemas/DiscoveryAzureKvKeyPolicyInfo" }, "type": "array" } }, "required": ["usage_violations", "management_violations"], "type": "object" } ] }, "DiscoveryAzureRegion": { "enum": [ "asia", "asia_pacific", "australia", "australia_central", "australia_central2", "australia_east", "australia_south_east", "brazil", "brazil_south", "brazil_south_east", "brazil_us", "canada", "canada_central", "canada_east", "central_india", "central_us", "central_us_euap", "central_us_stage", "east_asia", "east_asia_stage", "east_us", "east_us_stage", "east_us_stg", "east_us2", "east_us2_stage", "east_us2_euap", "europe", "france", "france_central", "france_south", "germany", "germany_north", "germany_west_central", "global", "india", "israel", "israel_central", "italy", "italy_north", "japan", "japan_east", "japan_west", "jio_india_central", "jio_india_west", "korea", "korea_central", "korea_south", "new_zealand", "north_central_us", "north_central_us_stage", "north_europe", "norway", "norway_east", "norway_west", "poland", "poland_central", "qatar", "qatar_central", "singapore", "south_africa", "south_africa_north", "south_africa_west", "south_central_us", "south_central_us_stage", "south_east_asia", "south_east_asia_stage", "south_india", "sweden", "sweden_central", "switzerland", "switzerland_north", "switzerland_west", "uae", "uae_central", "uae_north", "uk", "uk_south", "uk_west", "united_states", "united_states_euap", "west_central_us", "west_europe", "west_india", "west_us", "west_us_stage", "west_us2", "west_us2_stage", "west_us3", "other" ], "type": "string" }, "DiscoveryAzureRegionViolationMetrics": { "allOf": [ { "properties": { "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations_by_service_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryServiceViolationMetricsWithOverallRisk" }, "type": "object" } }, "required": ["overall_risk", "violations_by_service_type"], "type": "object" } ] }, "DiscoveryAzureResourceGroup": { "allOf": [ { "properties": { "name": { "type": "string" } }, "required": ["name"], "type": "object" } ] }, "DiscoveryAzureResourceGroupViolationMetrics": { "allOf": [ { "properties": { "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations_by_region": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryAzureRegionViolationMetrics" }, "type": "object" } }, "required": ["overall_risk", "violations_by_region"], "type": "object" } ] }, "DiscoveryAzureRiskAssessment": { "allOf": [ { "properties": { "findings": { "additionalProperties": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" }, "type": "object" }, "type": "object" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["findings", "overall_risk"], "type": "object" } ] }, "DiscoveryAzureScanAssessmentReport": { "allOf": [ { "properties": { "risk_assessment": { "$ref": "#/components/schemas/DiscoveryAzureRiskAssessment" }, "security_issues": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "description": "We will be returning a count of SharedKeys, NoncompliantKeys, ExpiredKeys, ExportableKeys, and QuantumVulnerableKeys violations.", "type": "object" }, "violations_by_service": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" }, "description": "We will be returning a count of ServicesEncryptedWithSharedKey, ServicesEncryptedWithNoncompliantKey, and UnencryptedServices violations.\nThese three counts will ve returned for all the Azure Services excluding the Key Vault.", "type": "object" } }, "required": [ "violations_by_service", "security_issues", "risk_assessment" ], "type": "object" } ] }, "DiscoveryAzureScannedServicesReportBySubscriptionParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryAzureScannedServicesResponseBySubscription": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryAzureServicesViolationMetrics" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryAzureServicesReportMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoveryAzureScope": { "description": "The scope that current Azure credentials should have access to", "discriminator": { "mapping": { "management_group": "DiscoveryAzureScopeVariantManagementGroup", "subscription": "DiscoveryAzureScopeVariantSubscription" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureScopeVariantManagementGroup" }, { "$ref": "#/components/schemas/DiscoveryAzureScopeVariantSubscription" } ] }, "DiscoveryAzureScopeManagementGroup": { "allOf": [ { "properties": { "management_group_id": { "type": "string" } }, "required": ["management_group_id"], "type": "object" } ] }, "DiscoveryAzureScopeSubscription": { "allOf": [ { "properties": { "subscription_id": { "format": "uuid", "type": "string" } }, "required": ["subscription_id"], "type": "object" } ] }, "DiscoveryAzureScopeVariantManagementGroup": { "allOf": [ { "properties": { "$type": { "enum": ["management_group"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureScopeManagementGroup" } ] }, "DiscoveryAzureScopeVariantSubscription": { "allOf": [ { "properties": { "$type": { "enum": ["subscription"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureScopeSubscription" } ] }, "DiscoveryAzureService": { "enum": [ "key_vaults", "storage_accounts", "sql_server", "cosmos_db", "container_groups", "managed_disks", "managed_clusters", "storage_account_blobs" ], "type": "string" }, "DiscoveryAzureServicesKeyCount": { "allOf": [ { "properties": { "azure_managed_key_encrypted": { "description": "Corresponds to the number of services encrypted with a Microsoft Managed Key or the Service Managed Key.", "type": "integer" }, "customer_managed_key_encrypted": { "description": "Corresponds to the number of services encrypted with a CMK that is stored in the Azure Key Vault.", "type": "integer" }, "total_services": { "description": "The total number of services.", "type": "integer" } }, "required": [ "total_services", "azure_managed_key_encrypted", "customer_managed_key_encrypted" ], "type": "object" } ] }, "DiscoveryAzureServicesReportMetadata": { "allOf": [ { "properties": { "region_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "resource_group_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "service_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "subscription_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "violation_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" } }, "required": [ "violation_metrics", "service_metrics", "region_metrics", "resource_group_metrics", "subscription_metrics" ], "type": "object" } ] }, "DiscoveryAzureServicesViolationMetrics": { "allOf": [ { "properties": { "subscription_id": { "format": "uuid", "type": "string" }, "violations_by_resource_group": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryAzureResourceGroupViolationMetrics" }, "type": "object" } }, "required": ["subscription_id", "violations_by_resource_group"], "type": "object" } ] }, "DiscoveryAzureSqlSingleServerTier": { "description": "The service tiers for SQL Single Server.", "enum": ["server", "serverless"], "type": "string" }, "DiscoveryAzureStorageAccount": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureStorageAnalysis" }, "blob_anonymous_access_enabled": { "type": "boolean" }, "encryption_settings": { "$ref": "#/components/schemas/DiscoveryAzureEncryptionSettings" }, "kind": { "$ref": "#/components/schemas/DiscoveryAzureStorageAccountKind" }, "name": { "type": "string" } }, "required": [ "name", "kind", "encryption_settings", "blob_anonymous_access_enabled", "analysis" ], "type": "object" } ] }, "DiscoveryAzureStorageAccountBlob": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryAzureStorageAccountBlobAnalysis" }, "container_name": { "type": "string" }, "encryption_settings": { "$ref": "#/components/schemas/DiscoveryAzureEncryptionSettings" }, "name": { "type": "string" }, "storage_account_name": { "type": "string" } }, "required": [ "name", "container_name", "storage_account_name", "encryption_settings", "analysis" ], "type": "object" } ] }, "DiscoveryAzureStorageAccountBlobAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "type": "boolean" }, "encrypted_with_exportable_key": { "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "type": "boolean" }, "encrypted_with_shared_key": { "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": [ "encrypted_with_noncompliant_key", "encrypted_with_overly_permissive_usage_key", "encrypted_with_overly_permissive_management_key", "key_availability", "encrypted_with_shared_key", "encrypted_with_quantum_vulnerable_key", "encrypted_with_expired_key", "encrypted_with_exportable_key" ], "type": "object" } ] }, "DiscoveryAzureStorageAccountKind": { "enum": [ "blob_storage", "block_blob_storage", "file_storage", "storage", "storage_v2", "unknown" ], "type": "string" }, "DiscoveryAzureStorageAnalysis": { "allOf": [ { "properties": { "encrypted_with_expired_key": { "nullable": true, "type": "boolean" }, "encrypted_with_exportable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_overly_permissive_management_key": { "nullable": true, "type": "boolean" }, "encrypted_with_overly_permissive_usage_key": { "nullable": true, "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" }, "encrypted_with_shared_key": { "nullable": true, "type": "boolean" }, "key_availability": { "$ref": "#/components/schemas/DiscoveryKeyAvailability" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryAzureStorageKeySource": { "description": "The encryption key source (provider).", "discriminator": { "mapping": { "key_vault": "DiscoveryAzureStorageKeySourceVariantKeyVault", "storage": "DiscoveryAzureStorageKeySourceVariantStorage" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAzureStorageKeySourceVariantKeyVault" }, { "$ref": "#/components/schemas/DiscoveryAzureStorageKeySourceVariantStorage" } ] }, "DiscoveryAzureStorageKeySourceKeyVault": { "allOf": [ { "description": "AzureStorageAccountKvProps changed to String.", "properties": { "key_id": { "type": "string" } }, "required": ["key_id"], "type": "object" } ] }, "DiscoveryAzureStorageKeySourceVariantKeyVault": { "allOf": [ { "properties": { "$type": { "enum": ["key_vault"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureStorageKeySourceKeyVault" } ] }, "DiscoveryAzureStorageKeySourceVariantStorage": { "allOf": [ { "properties": { "$type": { "enum": ["storage"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryAzureSubscription": { "allOf": [ { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" } }, "required": ["id", "name", "tenant_id"], "type": "object" } ] }, "DiscoveryAzureSubscriptionKeysCount": { "allOf": [ { "properties": { "enabled_keys": { "description": "Total number of keys that have been enabled and present in the subscription.", "type": "integer" }, "subscription": { "$ref": "#/components/schemas/DiscoveryAzureSubscription" }, "total_keys": { "description": "Total number of keys present in the subscription.", "type": "integer" } }, "required": ["subscription", "total_keys", "enabled_keys"], "type": "object" } ] }, "DiscoveryAzureSummaryData": { "allOf": [ { "properties": { "cloud_discovery": { "$ref": "#/components/schemas/DiscoveryAzureCloudDiscoveryData" }, "key_count_by_status": { "$ref": "#/components/schemas/DiscoveryAzureKeyCountByStatus" }, "key_count_by_type": { "additionalProperties": { "type": "integer" }, "description": "It returns the count of each key type.", "type": "object" }, "key_vault_count_by_access_tier": { "additionalProperties": { "type": "integer" }, "description": "Returns the count of standard and premium key vaults.", "type": "object" }, "protected_services": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryAzureServicesKeyCount" }, "description": "Gives an insight into the keys used for each service.", "type": "object" }, "top_subscriptions": { "description": "List of subscriptions (Max of 3) with max number of total keys.", "items": { "$ref": "#/components/schemas/DiscoveryAzureSubscriptionKeysCount" }, "type": "array" } }, "required": [ "cloud_discovery", "top_subscriptions", "protected_services", "key_count_by_status", "key_count_by_type", "key_vault_count_by_access_tier" ], "type": "object" } ] }, "DiscoveryBip32OptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryBlsOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryCertificateIssuer": { "allOf": [ { "type": "string" } ], "description": "Certificate's `issuer` generated from [DistinguishedName::to_string()]\n/ parseable by [DistinguishedName::from_str()]\nCertificate Distinguished Name (DN) mandated + optional fields,\nas defined in RFC 5280 §4.1.2.4 - used for both `issuer` and `subject`.\nASN.1 in the same RFC allows zero or more values for each of these fields.\n\nTo present it nicely in a UI:\n* Primary label: first `common_name` (CN).\n* Fallback: first `organization_name` (O).\n* Optional detail: append `organizational_unit_name` (OU), `country_name` (C),\nor `domain_component` (DC) as needed.\n\nThe string is presented as a serialized json from distinguished name map indexed by the short labels (uppercase) for each sub-field." }, "DiscoveryCertificateMetadata": { "allOf": [ { "properties": { "fingerprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "issuer_cn": { "additionalProperties": { "type": "string" }, "description": "Comes from `openssl_x509_name_to_map()`", "nullable": true, "type": "object" }, "pubkey_algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "serial": { "type": "string" }, "signature_algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "subject_cn": { "additionalProperties": { "type": "string" }, "description": "Comes from `openssl_x509_name_to_map()`", "nullable": true, "type": "object" }, "valid_from_unix_millis": { "type": "integer" }, "valid_to_unix_millis": { "type": "integer" } }, "required": [ "serial", "valid_from_unix_millis", "valid_to_unix_millis", "signature_algorithm", "pubkey_algorithm" ], "type": "object" } ] }, "DiscoveryCertificateOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryCertificateRevocationList": { "allOf": [ { "properties": { "issuer_cn": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "last_update": { "type": "string" }, "next_update": { "nullable": true, "type": "string" }, "revoked_certificates": { "items": { "$ref": "#/components/schemas/DiscoveryRevokedCertificate" }, "type": "array" }, "signature_algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" } }, "required": [ "last_update", "signature_algorithm", "revoked_certificates" ], "type": "object" } ] }, "DiscoveryCertificateSigningRequest": { "allOf": [ { "properties": { "pubkey_algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "signature_algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "subject_cn": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" } }, "required": ["signature_algorithm", "pubkey_algorithm"], "type": "object" } ] }, "DiscoveryCertificateSubject": { "allOf": [ { "type": "string" } ], "description": "Certificate's `subject` generated from [DistinguishedName::to_string()]\n/ parseable by [DistinguishedName::from_str()]\nCertificate Distinguished Name (DN) mandated + optional fields,\nas defined in RFC 5280 §4.1.2.4 - used for both `issuer` and `subject`.\nASN.1 in the same RFC allows zero or more values for each of these fields.\n\nTo present it nicely in a UI:\n* Primary label: first `common_name` (CN).\n* Fallback: first `organization_name` (O).\n* Optional detail: append `organizational_unit_name` (OU), `country_name` (C),\nor `domain_component` (DC) as needed.\n\nThe string is presented as a serialized json from distinguished name map indexed by the short labels (uppercase) for each sub-field." }, "DiscoveryCloudProviderServiceType": { "discriminator": { "mapping": { "aws": "DiscoveryCloudProviderServiceTypeVariantAws", "azure": "DiscoveryCloudProviderServiceTypeVariantAzure" }, "propertyName": "cloud_provider" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryCloudProviderServiceTypeVariantAws" }, { "$ref": "#/components/schemas/DiscoveryCloudProviderServiceTypeVariantAzure" } ] }, "DiscoveryCloudProviderServiceTypeAws": { "allOf": [ { "properties": { "service_type": { "$ref": "#/components/schemas/DiscoveryAwsService" } }, "required": ["service_type"], "type": "object" } ] }, "DiscoveryCloudProviderServiceTypeAzure": { "allOf": [ { "properties": { "service_type": { "$ref": "#/components/schemas/DiscoveryAzureService" } }, "required": ["service_type"], "type": "object" } ] }, "DiscoveryCloudProviderServiceTypeVariantAws": { "allOf": [ { "properties": { "cloud_provider": { "enum": ["aws"], "type": "string" } }, "required": ["cloud_provider"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryCloudProviderServiceTypeAws" } ] }, "DiscoveryCloudProviderServiceTypeVariantAzure": { "allOf": [ { "properties": { "cloud_provider": { "enum": ["azure"], "type": "string" } }, "required": ["cloud_provider"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryCloudProviderServiceTypeAzure" } ] }, "DiscoveryConnection": { "allOf": [ { "properties": { "acct_id": { "description": "Uuid of the account that the connection belongs to", "format": "uuid", "type": "string" }, "connection_config": { "$ref": "#/components/schemas/DiscoveryConnectionConfig" }, "connection_id": { "description": "An internally generated Uuid for the Connection type", "format": "uuid", "type": "string" }, "created_at": { "description": "The time this Connection object was created", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "external_key_sources": { "description": "External key source", "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array", "uniqueItems": true }, "group_id": { "description": "Uuid of the group to which the connection object belongs", "format": "uuid", "type": "string" }, "name": { "description": "Name of the Connection", "maxLength": 4096, "pattern": "^[^\\n]*[^\\s\\n][^\\n]*$", "type": "string" }, "policies": { "$ref": "#/components/schemas/DiscoveryConnectionPolicies" }, "scan_filter": { "description": "The scan filter representing which cloud service provider entities to scan" } }, "required": [ "connection_id", "name", "acct_id", "group_id", "created_at", "scan_filter", "connection_config" ], "type": "object" } ] }, "DiscoveryConnectionConfig": { "discriminator": { "mapping": { "aws": "DiscoveryConnectionConfigVariantAws", "azure": "DiscoveryConnectionConfigVariantAzure", "dsm": "DiscoveryConnectionConfigVariantDsm", "dsm_agent": "DiscoveryConnectionConfigVariantDsmAgent", "on_prem": "DiscoveryConnectionConfigVariantOnPrem" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryConnectionConfigVariantAws" }, { "$ref": "#/components/schemas/DiscoveryConnectionConfigVariantAzure" }, { "$ref": "#/components/schemas/DiscoveryConnectionConfigVariantOnPrem" }, { "$ref": "#/components/schemas/DiscoveryConnectionConfigVariantDsm" }, { "$ref": "#/components/schemas/DiscoveryConnectionConfigVariantDsmAgent" } ] }, "DiscoveryConnectionConfigVariantAws": { "allOf": [ { "properties": { "$type": { "enum": ["aws"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsConfig" } ] }, "DiscoveryConnectionConfigVariantAzure": { "allOf": [ { "properties": { "$type": { "enum": ["azure"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureConfig" } ] }, "DiscoveryConnectionConfigVariantDsm": { "allOf": [ { "properties": { "$type": { "enum": ["dsm"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmConnectionConfig" } ] }, "DiscoveryConnectionConfigVariantDsmAgent": { "allOf": [ { "properties": { "$type": { "enum": ["dsm_agent"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmAgentConnectionConfig" } ] }, "DiscoveryConnectionConfigVariantOnPrem": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremConnection" } ] }, "DiscoveryConnectionCorrelationData": { "allOf": [ { "properties": { "connection_id": { "format": "uuid", "type": "string" }, "connection_name": { "maxLength": 4096, "pattern": "^[^\\n]*[^\\s\\n][^\\n]*$", "type": "string" }, "correlated_keys_count": { "type": "integer" } }, "required": [ "connection_id", "connection_name", "correlated_keys_count" ], "type": "object" } ] }, "DiscoveryConnectionCredential": { "discriminator": { "mapping": { "dsm_agent": "DiscoveryConnectionCredentialVariantDsmAgent", "dsm_certificate": "DiscoveryConnectionCredentialVariantDsmCertificate" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryConnectionCredentialVariantDsmCertificate" }, { "$ref": "#/components/schemas/DiscoveryConnectionCredentialVariantDsmAgent" } ] }, "DiscoveryConnectionCredentialVariantDsmAgent": { "allOf": [ { "properties": { "$type": { "enum": ["dsm_agent"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmAgentCredential" } ] }, "DiscoveryConnectionCredentialVariantDsmCertificate": { "allOf": [ { "properties": { "$type": { "enum": ["dsm_certificate"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmCertificate" } ] }, "DiscoveryConnectionPolicies": { "allOf": [ { "properties": { "crypto_policy": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryCryptographicAlgorithm": { "oneOf": [ { "properties": { "skipped": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["skipped"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmAes": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmDes": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmDsa": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEc": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEcdh": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEcdsa": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEcmqv": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEd25519": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmEdDsa": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmHmacSha": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmOther": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "name": { "type": "string" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size", "name"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmRc2": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmRsa": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmSha": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmSha3": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmShake": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmSike": { "allOf": [ { "properties": { "curve": { "$ref": "#/components/schemas/DiscoveryCurve" }, "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicAlgorithmTripleDes": { "allOf": [ { "properties": { "size": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["size"], "type": "object" } ] }, "DiscoveryCryptographicMetadata": { "oneOf": [ { "properties": { "symmetric_key": { "$ref": "#/components/schemas/DiscoverySymmetricKeyMetadata" } }, "required": ["symmetric_key"], "title": "DiscoveryCryptographicMetadataVariantSymmetricKey", "type": "object" }, { "properties": { "public_key": { "$ref": "#/components/schemas/DiscoveryPublicKeyMetadata" } }, "required": ["public_key"], "title": "DiscoveryCryptographicMetadataVariantPublicKey", "type": "object" }, { "properties": { "private_key": { "$ref": "#/components/schemas/DiscoveryPrivateKeyMetadata" } }, "required": ["private_key"], "title": "DiscoveryCryptographicMetadataVariantPrivateKey", "type": "object" }, { "properties": { "certificate": { "$ref": "#/components/schemas/DiscoveryCertificateMetadata" } }, "required": ["certificate"], "title": "DiscoveryCryptographicMetadataVariantCertificate", "type": "object" }, { "properties": { "trusted_certificate": { "$ref": "#/components/schemas/DiscoveryTrustedCertificateMetadata" } }, "required": ["trusted_certificate"], "title": "DiscoveryCryptographicMetadataVariantTrustedCertificate", "type": "object" }, { "properties": { "certificate_signing_request": { "$ref": "#/components/schemas/DiscoveryCertificateSigningRequest" } }, "required": ["certificate_signing_request"], "title": "DiscoveryCryptographicMetadataVariantCertificateSigningRequest", "type": "object" }, { "properties": { "certificate_revocation_list": { "$ref": "#/components/schemas/DiscoveryCertificateRevocationList" } }, "required": ["certificate_revocation_list"], "title": "DiscoveryCryptographicMetadataVariantCertificateRevocationList", "type": "object" }, { "properties": { "pkcs7": { "$ref": "#/components/schemas/DiscoveryPkcs7Metadata" } }, "required": ["pkcs7"], "title": "DiscoveryCryptographicMetadataVariantPkcs7", "type": "object" }, { "properties": { "pkcs12": { "$ref": "#/components/schemas/DiscoveryPkcs12Metadata" } }, "required": ["pkcs12"], "title": "DiscoveryCryptographicMetadataVariantPkcs12", "type": "object" }, { "properties": { "parameters": { "$ref": "#/components/schemas/DiscoveryParametersMetadata" } }, "required": ["parameters"], "title": "DiscoveryCryptographicMetadataVariantParameters", "type": "object" }, { "properties": { "jwt": { "$ref": "#/components/schemas/DiscoveryJwtMetadata" } }, "required": ["jwt"], "title": "DiscoveryCryptographicMetadataVariantJwt", "type": "object" }, { "properties": { "ssh": { "$ref": "#/components/schemas/DiscoverySshMetadata" } }, "required": ["ssh"], "title": "DiscoveryCryptographicMetadataVariantSsh", "type": "object" }, { "properties": { "pgp": { "$ref": "#/components/schemas/DiscoveryPgpMetadata" } }, "required": ["pgp"], "title": "DiscoveryCryptographicMetadataVariantPgp", "type": "object" }, { "properties": { "multiple": { "description": "This is used if a single file contains multiple crytpogrpahic materials within it. This primarily applies\nto PEM files, as multiple PEM blocks can be concatenated together without issue.", "items": { "$ref": "#/components/schemas/DiscoveryCryptographicMetadata" }, "type": "array" } }, "required": ["multiple"], "title": "DiscoveryCryptographicMetadataVariantMultiple", "type": "object" } ] }, "DiscoveryCryptographicPolicy": { "allOf": [ { "properties": { "aes": { "$ref": "#/components/schemas/DiscoveryAesOptionsPolicy" }, "aria": { "$ref": "#/components/schemas/DiscoveryAriaOptionsPolicy" }, "bip32": { "$ref": "#/components/schemas/DiscoveryBip32OptionsPolicy" }, "bls": { "$ref": "#/components/schemas/DiscoveryBlsOptionsPolicy" }, "certificate": { "$ref": "#/components/schemas/DiscoveryCertificateOptionsPolicy" }, "des": { "$ref": "#/components/schemas/DiscoveryDesOptionsPolicy" }, "des3": { "$ref": "#/components/schemas/DiscoveryDes3OptionsPolicy" }, "dsa": { "$ref": "#/components/schemas/DiscoveryDsaOptionsPolicy" }, "ec": { "$ref": "#/components/schemas/DiscoveryEcOptionsPolicy" }, "eckcdsa": { "$ref": "#/components/schemas/DiscoveryEcKcdsaOptionsPolicy" }, "hmac": { "$ref": "#/components/schemas/DiscoveryHmacOptionsPolicy" }, "kcdsa": { "$ref": "#/components/schemas/DiscoveryKcdsaOptionsPolicy" }, "key_ops": { "items": { "$ref": "#/components/schemas/DiscoveryKeyOperations" }, "nullable": true, "type": "array" }, "legacy_policy": { "$ref": "#/components/schemas/DiscoveryLegacyKeyPolicy" }, "lms": { "$ref": "#/components/schemas/DiscoveryLmsOptionsPolicy" }, "mldsa": { "$ref": "#/components/schemas/DiscoveryMlDsaOptionsPolicy" }, "mlkem": { "$ref": "#/components/schemas/DiscoveryMlKemOptionsPolicy" }, "opaque": { "$ref": "#/components/schemas/DiscoveryOpaqueOptionsPolicy" }, "rsa": { "$ref": "#/components/schemas/DiscoveryRsaOptionsPolicy" }, "secret": { "$ref": "#/components/schemas/DiscoverySecretOptionsPolicy" }, "seed": { "$ref": "#/components/schemas/DiscoverySeedOptionsPolicy" }, "slip10": { "$ref": "#/components/schemas/DiscoverySlip10OptionsPolicy" }, "xmss": { "$ref": "#/components/schemas/DiscoveryXmssOptionsPolicy" } }, "type": "object" } ] }, "DiscoveryCspServicesMetadata": { "discriminator": { "mapping": { "aws": "DiscoveryCspServicesMetadataVariantAws", "azure": "DiscoveryCspServicesMetadataVariantAzure" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryCspServicesMetadataVariantAws" }, { "$ref": "#/components/schemas/DiscoveryCspServicesMetadataVariantAzure" } ] }, "DiscoveryCspServicesMetadataVariantAws": { "allOf": [ { "properties": { "$type": { "enum": ["aws"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsFilterMetadata" } ] }, "DiscoveryCspServicesMetadataVariantAzure": { "allOf": [ { "properties": { "$type": { "enum": ["azure"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureFilterMetadata" } ] }, "DiscoveryCurve": { "description": "Elliptic curves for selected crypto algorithms", "oneOf": [ { "enum": ["p256"], "title": "DiscoveryCurveVariantP256", "type": "string" }, { "enum": ["p384"], "title": "DiscoveryCurveVariantP384", "type": "string" }, { "enum": ["p521"], "title": "DiscoveryCurveVariantP521", "type": "string" }, { "enum": ["k256"], "title": "DiscoveryCurveVariantK256", "type": "string" }, { "enum": ["x25519"], "title": "DiscoveryCurveVariantX25519", "type": "string" }, { "enum": ["ed25519"], "title": "DiscoveryCurveVariantEd25519", "type": "string" }, { "enum": ["x448"], "title": "DiscoveryCurveVariantX448", "type": "string" }, { "enum": ["ed448"], "title": "DiscoveryCurveVariantEd448", "type": "string" }, { "enum": ["brainpool_p256r1"], "title": "DiscoveryCurveVariantBrainpoolP256r1", "type": "string" }, { "enum": ["brainpool_p384r1"], "title": "DiscoveryCurveVariantBrainpoolP384r1", "type": "string" }, { "enum": ["brainpool_p512r1"], "title": "DiscoveryCurveVariantBrainpoolP512r1", "type": "string" }, { "properties": { "other": { "description": "A catch-all if you really need to accept arbitrary curve names", "type": "string" } }, "required": ["other"], "title": "DiscoveryCurveVariantOther", "type": "object" }, { "enum": ["prime192_v1"], "title": "DiscoveryCurveVariantPrime192V1", "type": "string" }, { "enum": ["prime192_v2"], "title": "DiscoveryCurveVariantPrime192V2", "type": "string" }, { "enum": ["prime192_v3"], "title": "DiscoveryCurveVariantPrime192V3", "type": "string" }, { "enum": ["prime239_v1"], "title": "DiscoveryCurveVariantPrime239V1", "type": "string" }, { "enum": ["prime239_v2"], "title": "DiscoveryCurveVariantPrime239V2", "type": "string" }, { "enum": ["prime239_v3"], "title": "DiscoveryCurveVariantPrime239V3", "type": "string" }, { "enum": ["prime256_v1"], "title": "DiscoveryCurveVariantPrime256V1", "type": "string" }, { "enum": ["ansi_t163_k1"], "title": "DiscoveryCurveVariantAnsiT163K1", "type": "string" }, { "enum": ["ansi_t163_r1"], "title": "DiscoveryCurveVariantAnsiT163R1", "type": "string" }, { "enum": ["ansi_t239_k1"], "title": "DiscoveryCurveVariantAnsiT239K1", "type": "string" }, { "enum": ["sec_t113_r1"], "title": "DiscoveryCurveVariantSecT113R1", "type": "string" }, { "enum": ["sec_t113_r2"], "title": "DiscoveryCurveVariantSecT113R2", "type": "string" }, { "enum": ["sec_p112_r1"], "title": "DiscoveryCurveVariantSecP112R1", "type": "string" }, { "enum": ["sec_p112_r2"], "title": "DiscoveryCurveVariantSecP112R2", "type": "string" }, { "enum": ["ansi_p160_r1"], "title": "DiscoveryCurveVariantAnsiP160R1", "type": "string" }, { "enum": ["ansi_p160_k1"], "title": "DiscoveryCurveVariantAnsiP160K1", "type": "string" }, { "enum": ["ansi_p256_k1"], "title": "DiscoveryCurveVariantAnsiP256K1", "type": "string" }, { "enum": ["ansi_t163_r2"], "title": "DiscoveryCurveVariantAnsiT163R2", "type": "string" }, { "enum": ["ansi_t283_k1"], "title": "DiscoveryCurveVariantAnsiT283K1", "type": "string" }, { "enum": ["ansi_t283_r1"], "title": "DiscoveryCurveVariantAnsiT283R1", "type": "string" }, { "enum": ["sec_t131_r1"], "title": "DiscoveryCurveVariantSecT131R1", "type": "string" }, { "enum": ["sec_t131_r2"], "title": "DiscoveryCurveVariantSecT131R2", "type": "string" }, { "enum": ["ansi_t193_r1"], "title": "DiscoveryCurveVariantAnsiT193R1", "type": "string" }, { "enum": ["ansi_t193_r2"], "title": "DiscoveryCurveVariantAnsiT193R2", "type": "string" }, { "enum": ["ansi_t233_k1"], "title": "DiscoveryCurveVariantAnsiT233K1", "type": "string" }, { "enum": ["ansi_t233_r1"], "title": "DiscoveryCurveVariantAnsiT233R1", "type": "string" }, { "enum": ["sec_p128_r1"], "title": "DiscoveryCurveVariantSecP128R1", "type": "string" }, { "enum": ["sec_p128_r2"], "title": "DiscoveryCurveVariantSecP128R2", "type": "string" }, { "enum": ["ansi_p160_r2"], "title": "DiscoveryCurveVariantAnsiP160R2", "type": "string" }, { "enum": ["ansi_p192_k1"], "title": "DiscoveryCurveVariantAnsiP192K1", "type": "string" }, { "enum": ["ansi_p224_k1"], "title": "DiscoveryCurveVariantAnsiP224K1", "type": "string" }, { "enum": ["ansi_p224_r1"], "title": "DiscoveryCurveVariantAnsiP224R1", "type": "string" }, { "enum": ["ansi_p384_r1"], "title": "DiscoveryCurveVariantAnsiP384R1", "type": "string" }, { "enum": ["ansi_p521_r1"], "title": "DiscoveryCurveVariantAnsiP521R1", "type": "string" }, { "enum": ["ansi_t409_k1"], "title": "DiscoveryCurveVariantAnsiT409K1", "type": "string" }, { "enum": ["ansi_t409_r1"], "title": "DiscoveryCurveVariantAnsiT409R1", "type": "string" }, { "enum": ["ansi_t571_k1"], "title": "DiscoveryCurveVariantAnsiT571K1", "type": "string" }, { "enum": ["ansi_t571_r1"], "title": "DiscoveryCurveVariantAnsiT571R1", "type": "string" }, { "enum": ["c2_pnb163_v1"], "title": "DiscoveryCurveVariantC2Pnb163V1", "type": "string" }, { "enum": ["c2_pnb163_v2"], "title": "DiscoveryCurveVariantC2Pnb163V2", "type": "string" }, { "enum": ["c2_pnb163_v3"], "title": "DiscoveryCurveVariantC2Pnb163V3", "type": "string" }, { "enum": ["c2_pnb176_w1"], "title": "DiscoveryCurveVariantC2Pnb176W1", "type": "string" }, { "enum": ["c2_tnb191_v1"], "title": "DiscoveryCurveVariantC2Tnb191V1", "type": "string" }, { "enum": ["c2_tnb191_v2"], "title": "DiscoveryCurveVariantC2Tnb191V2", "type": "string" }, { "enum": ["c2_tnb191_v3"], "title": "DiscoveryCurveVariantC2Tnb191V3", "type": "string" }, { "enum": ["c2_onb191_v4"], "title": "DiscoveryCurveVariantC2Onb191V4", "type": "string" }, { "enum": ["c2_onb191_v5"], "title": "DiscoveryCurveVariantC2Onb191V5", "type": "string" }, { "enum": ["c2_pnb208_w1"], "title": "DiscoveryCurveVariantC2Pnb208W1", "type": "string" }, { "enum": ["c2_tnb239_v1"], "title": "DiscoveryCurveVariantC2Tnb239V1", "type": "string" }, { "enum": ["c2_tnb239_v2"], "title": "DiscoveryCurveVariantC2Tnb239V2", "type": "string" }, { "enum": ["c2_tnb239_v3"], "title": "DiscoveryCurveVariantC2Tnb239V3", "type": "string" }, { "enum": ["c2_onb239_v4"], "title": "DiscoveryCurveVariantC2Onb239V4", "type": "string" }, { "enum": ["c2_onb239_v5"], "title": "DiscoveryCurveVariantC2Onb239V5", "type": "string" }, { "enum": ["c2_pnb272_w1"], "title": "DiscoveryCurveVariantC2Pnb272W1", "type": "string" }, { "enum": ["c2_pnb304_w1"], "title": "DiscoveryCurveVariantC2Pnb304W1", "type": "string" }, { "enum": ["c2_tnb359_v1"], "title": "DiscoveryCurveVariantC2Tnb359V1", "type": "string" }, { "enum": ["c2_pnb368_w1"], "title": "DiscoveryCurveVariantC2Pnb368W1", "type": "string" }, { "enum": ["c2_tnb431_r1"], "title": "DiscoveryCurveVariantC2Tnb431R1", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls1"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls1", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls3"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls3", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls4"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls4", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls5"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls5", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls6"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls6", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls7"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls7", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls8"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls8", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls9"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls9", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls10"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls10", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls11"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls11", "type": "string" }, { "enum": ["wap_wsg_idm_ecid_wtls12"], "title": "DiscoveryCurveVariantWapWsgIdmEcidWtls12", "type": "string" }, { "enum": ["brainpool_p160_r1"], "title": "DiscoveryCurveVariantBrainpoolP160R1", "type": "string" }, { "enum": ["brainpool_p160_t1"], "title": "DiscoveryCurveVariantBrainpoolP160T1", "type": "string" }, { "enum": ["brainpool_p192_r1"], "title": "DiscoveryCurveVariantBrainpoolP192R1", "type": "string" }, { "enum": ["brainpool_p192_t1"], "title": "DiscoveryCurveVariantBrainpoolP192T1", "type": "string" }, { "enum": ["brainpool_p224_r1"], "title": "DiscoveryCurveVariantBrainpoolP224R1", "type": "string" }, { "enum": ["brainpool_p224_t1"], "title": "DiscoveryCurveVariantBrainpoolP224T1", "type": "string" }, { "enum": ["brainpool_p256_r1"], "title": "DiscoveryCurveVariantBrainpoolP256R1", "type": "string" }, { "enum": ["brainpool_p256_t1"], "title": "DiscoveryCurveVariantBrainpoolP256T1", "type": "string" }, { "enum": ["brainpool_p320_r1"], "title": "DiscoveryCurveVariantBrainpoolP320R1", "type": "string" }, { "enum": ["brainpool_p320_t1"], "title": "DiscoveryCurveVariantBrainpoolP320T1", "type": "string" }, { "enum": ["brainpool_p384_r1"], "title": "DiscoveryCurveVariantBrainpoolP384R1", "type": "string" }, { "enum": ["brainpool_p384_t1"], "title": "DiscoveryCurveVariantBrainpoolP384T1", "type": "string" }, { "enum": ["brainpool_p512_r1"], "title": "DiscoveryCurveVariantBrainpoolP512R1", "type": "string" }, { "enum": ["brainpool_p512_t1"], "title": "DiscoveryCurveVariantBrainpoolP512T1", "type": "string" } ] }, "DiscoveryDes3OptionsPolicy": { "allOf": [ { "description": "Cryptographic policy for triple DES objects. Setting `key_sizes: [168]`\nforbids two-key triple DES.", "properties": { "key_sizes": { "items": { "maximum": 4294967295, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "random_iv": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryDesOptionsPolicy": { "allOf": [ { "properties": { "random_iv": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryDiffieHellmanParamsMetadata": { "allOf": [ { "properties": { "g": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" }, "p": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" }, "q": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" } }, "required": ["p", "g"], "type": "object" } ] }, "DiscoveryDigestAlgorithm": { "description": "A hash algorithm.", "enum": [ "BLAKE2B256", "BLAKE2B384", "BLAKE2B512", "BLAKE2S256", "RIPEMD160", "SSL3", "SHA1", "SHA224", "SHA256", "SHA384", "SHA512", "STREEBOG256", "STREEBOG512", "SHA3_224", "SHA3_256", "SHA3_384", "SHA3_512" ], "type": "string" }, "DiscoveryDsaOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryDsmAgentConnectionConfig": { "allOf": [ { "properties": { "credentials": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryConnectionCredential" }, "type": "object" }, "details": { "$ref": "#/components/schemas/DiscoveryDsmAgentDetails" }, "state": { "$ref": "#/components/schemas/DiscoveryDsmAgentConnectionState" } }, "required": ["state", "credentials"], "type": "object" } ] }, "DiscoveryDsmAgentConnectionState": { "allOf": [ { "properties": { "last_polled_at": { "description": "The time this DsmAgentConnection was last polled", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "status": { "$ref": "#/components/schemas/DiscoveryDsmAgentConnectionStatus" } }, "required": ["status"], "type": "object" } ] }, "DiscoveryDsmAgentConnectionStatus": { "enum": ["pending", "connected", "disconnected"], "type": "string" }, "DiscoveryDsmAgentCredential": { "allOf": [ { "properties": { "credential": { "$ref": "#/components/schemas/DiscoveryDsmAgentCredentialDetails" } }, "required": ["credential"], "type": "object" } ] }, "DiscoveryDsmAgentCredentialDetails": { "discriminator": { "mapping": { "secret": "DiscoveryDsmAgentCredentialDetailsVariantSecret" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryDsmAgentCredentialDetailsVariantSecret" } ] }, "DiscoveryDsmAgentCredentialDetailsSecret": { "allOf": [ { "properties": { "created_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "credential_id": { "format": "uuid", "type": "string" }, "value": { "type": "string" } }, "required": ["credential_id", "created_at", "value"], "type": "object" } ] }, "DiscoveryDsmAgentCredentialDetailsVariantSecret": { "allOf": [ { "properties": { "$type": { "enum": ["secret"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmAgentCredentialDetailsSecret" } ] }, "DiscoveryDsmAgentDetails": { "allOf": [ { "properties": { "agent_hostname": { "nullable": true, "type": "string" }, "app_id": { "format": "uuid", "nullable": true, "type": "string" }, "dsm_account_id": { "format": "uuid", "nullable": true, "type": "string" }, "dsm_url": { "format": "url", "type": "string" } }, "required": ["dsm_url"], "type": "object" } ] }, "DiscoveryDsmCertificate": { "allOf": [ { "properties": { "app_id": { "format": "uuid", "nullable": true, "type": "string" }, "certificate_chain": { "items": { "format": "byte", "type": "string" }, "nullable": true, "type": "array" }, "created_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "credential_id": { "type": "string" }, "private_key": { "format": "byte", "type": "string" } }, "required": ["credential_id", "created_at"], "type": "object" } ] }, "DiscoveryDsmConnectionConfig": { "allOf": [ { "properties": { "active_credential_id": { "nullable": true, "type": "string" }, "credentials": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryConnectionCredential" }, "nullable": true, "type": "object" }, "deployment": { "$ref": "#/components/schemas/DiscoveryDsmDeployment" } }, "required": ["deployment"], "type": "object" } ] }, "DiscoveryDsmCryptoPolicyCompliance": { "allOf": [ { "properties": { "is_compliant": { "type": "boolean" }, "violation_reason": { "nullable": true, "type": "string" } }, "required": ["is_compliant"], "type": "object" } ] }, "DiscoveryDsmDeployment": { "discriminator": { "mapping": { "other": "DiscoveryDsmDeploymentVariantOther", "saas": "DiscoveryDsmDeploymentVariantSaaS" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryDsmDeploymentVariantSaaS" }, { "$ref": "#/components/schemas/DiscoveryDsmDeploymentVariantOther" } ] }, "DiscoveryDsmDeploymentOther": { "allOf": [ { "properties": { "url": { "format": "url", "type": "string" } }, "required": ["url"], "type": "object" } ] }, "DiscoveryDsmDeploymentSaaS": { "allOf": [ { "properties": { "region": { "$ref": "#/components/schemas/DiscoveryDsmRegion" } }, "required": ["region"], "type": "object" } ] }, "DiscoveryDsmDeploymentVariantOther": { "allOf": [ { "properties": { "$type": { "enum": ["other"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmDeploymentOther" } ] }, "DiscoveryDsmDeploymentVariantSaaS": { "allOf": [ { "properties": { "$type": { "enum": ["saas"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmDeploymentSaaS" } ] }, "DiscoveryDsmHmgConfig": { "allOf": [ { "properties": { "hmg_type": { "$ref": "#/components/schemas/DiscoveryDsmHmgConfigType" }, "url": { "nullable": true, "type": "string" } }, "required": ["hmg_type"], "type": "object" } ] }, "DiscoveryDsmHmgConfigType": { "enum": [ "ncipher", "safenet", "aws_cloud_hsm", "aws_kms", "fortanix", "fortanix_fips_cluster", "azure_key_vault", "gcp_key_ring", "other" ], "type": "string" }, "DiscoveryDsmKeyAlgorithmData": { "allOf": [ { "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryDsmKeysDiscoveryData": { "allOf": [ { "properties": { "correlated_keys": { "type": "integer" }, "total_keys": { "type": "integer" } }, "required": ["total_keys", "correlated_keys"], "type": "object" } ] }, "DiscoveryDsmObject": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryDsmObjectDetails" }, "dsm_account_id": { "format": "uuid", "type": "string" } }, "required": ["dsm_account_id", "details"], "type": "object" } ] }, "DiscoveryDsmObjectDetails": { "discriminator": { "mapping": { "dsm_sobject": "DiscoveryDsmObjectDetailsVariantDsmSobject" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryDsmObjectDetailsVariantDsmSobject" } ] }, "DiscoveryDsmObjectDetailsVariantDsmSobject": { "allOf": [ { "properties": { "$type": { "enum": ["dsm_sobject"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmSobject" } ] }, "DiscoveryDsmRegion": { "enum": [ "north_america", "european_union", "united_kingdom", "asia_pacific", "australia", "saudi_arabia" ], "type": "string" }, "DiscoveryDsmResourceType": { "description": "Useful for specifying [InventoryObjectExternalId]s", "enum": ["dsm_sobject"], "type": "string" }, "DiscoveryDsmScanSummaryData": { "allOf": [ { "properties": { "connection_correlation_data": { "items": { "$ref": "#/components/schemas/DiscoveryConnectionCorrelationData" }, "type": "array" }, "keys_by_status": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryDsmSummaryKeyStatusData" }, "type": "object" }, "keys_by_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryDsmKeyAlgorithmData" }, "type": "object" }, "keys_discovery": { "$ref": "#/components/schemas/DiscoveryDsmKeysDiscoveryData" } }, "required": [ "keys_by_status", "keys_by_type", "connection_correlation_data" ], "type": "object" } ] }, "DiscoveryDsmSobject": { "allOf": [ { "properties": { "activation_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "analysis": { "$ref": "#/components/schemas/DiscoveryDsmSobjectAnalysis" }, "compromise_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "creation_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "custom_metadata": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "deactivation_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "deletion_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "description": { "nullable": true, "type": "string" }, "destruction_date": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "dsm_group_id": { "format": "uuid", "type": "string" }, "dsm_group_name": { "nullable": true, "type": "string" }, "elliptic_curve": { "$ref": "#/components/schemas/DiscoveryDsmSobjectEllipticCurve" }, "hmg_configs": { "items": { "$ref": "#/components/schemas/DiscoveryDsmHmgConfig" }, "nullable": true, "type": "array" }, "is_enabled": { "type": "boolean" }, "kcv": { "nullable": true, "type": "string" }, "key_links": { "$ref": "#/components/schemas/DiscoveryDsmSobjectKeyLinks" }, "key_operations": { "items": { "$ref": "#/components/schemas/DiscoveryDsmSobjectKeyOperations" }, "nullable": true, "type": "array" }, "key_size": { "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "type": "string" }, "object_type": { "$ref": "#/components/schemas/DiscoveryDsmSobjectType" }, "origin": { "$ref": "#/components/schemas/DiscoveryDsmSobjectOrigin" }, "rotation_policy": { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationPolicy" }, "sobject_id": { "format": "uuid", "type": "string" }, "state": { "$ref": "#/components/schemas/DiscoveryDsmSobjectState" } }, "required": [ "sobject_id", "name", "state", "creation_date", "object_type", "origin", "is_enabled", "dsm_group_id", "analysis" ], "type": "object" } ] }, "DiscoveryDsmSobjectAnalysis": { "allOf": [ { "properties": { "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryDsmCryptoPolicyCompliance" }, "is_source_key": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryDsmSobjectEllipticCurve": { "enum": [ "x25519", "ed25519", "x448", "secp192k1", "secp224k1", "secp256k1", "nistp192", "nistp224", "nistp256", "nistp384", "nistp521", "gost256a", "other" ], "type": "string" }, "DiscoveryDsmSobjectKeyLinks": { "allOf": [ { "properties": { "copied_from": { "format": "uuid", "nullable": true, "type": "string" }, "copied_to": { "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array" }, "parent": { "format": "uuid", "nullable": true, "type": "string" }, "replaced": { "format": "uuid", "nullable": true, "type": "string" }, "replacement": { "format": "uuid", "nullable": true, "type": "string" }, "subkeys": { "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array" }, "wrapping_key": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryDsmSobjectKeyOperations": { "description": "Operations Allowed To Be Performed On A Given Key.", "enum": [ "sign", "verify", "encrypt", "decrypt", "wrapkey", "unwrapkey", "derivekey", "transform", "macgenerate", "macverify", "export", "appmanageable", "highvolume", "agreekey", "encapsulate", "decapsulate", "other" ], "type": "string" }, "DiscoveryDsmSobjectOrigin": { "description": "The origin of a security object - where it was created / generated.", "enum": ["fortanix_hsm", "transient", "external", "other"], "type": "string" }, "DiscoveryDsmSobjectRotateCopiedKeys": { "discriminator": { "mapping": { "all_external": "DiscoveryDsmSobjectRotateCopiedKeysVariantAllExternal", "other": "DiscoveryDsmSobjectRotateCopiedKeysVariantOther", "select": "DiscoveryDsmSobjectRotateCopiedKeysVariantSelect" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotateCopiedKeysVariantAllExternal" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotateCopiedKeysVariantSelect" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotateCopiedKeysVariantOther" } ] }, "DiscoveryDsmSobjectRotateCopiedKeysSelect": { "allOf": [ { "properties": { "sobject_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": ["sobject_ids"], "type": "object" } ] }, "DiscoveryDsmSobjectRotateCopiedKeysVariantAllExternal": { "allOf": [ { "properties": { "$type": { "enum": ["all_external"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryDsmSobjectRotateCopiedKeysVariantOther": { "allOf": [ { "properties": { "$type": { "enum": ["other"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryDsmSobjectRotateCopiedKeysVariantSelect": { "allOf": [ { "properties": { "$type": { "enum": ["select"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotateCopiedKeysSelect" } ] }, "DiscoveryDsmSobjectRotationInterval": { "discriminator": { "mapping": { "interval_days": "DiscoveryDsmSobjectRotationIntervalVariantIntervalDays", "interval_months": "DiscoveryDsmSobjectRotationIntervalVariantIntervalMonths", "other": "DiscoveryDsmSobjectRotationIntervalVariantOther" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationIntervalVariantIntervalDays" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationIntervalVariantIntervalMonths" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationIntervalVariantOther" } ] }, "DiscoveryDsmSobjectRotationIntervalIntervalDays": { "allOf": [ { "properties": { "days": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["days"], "type": "object" } ] }, "DiscoveryDsmSobjectRotationIntervalIntervalMonths": { "allOf": [ { "properties": { "months": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["months"], "type": "object" } ] }, "DiscoveryDsmSobjectRotationIntervalVariantIntervalDays": { "allOf": [ { "properties": { "$type": { "enum": ["interval_days"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationIntervalIntervalDays" } ] }, "DiscoveryDsmSobjectRotationIntervalVariantIntervalMonths": { "allOf": [ { "properties": { "$type": { "enum": ["interval_months"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationIntervalIntervalMonths" } ] }, "DiscoveryDsmSobjectRotationIntervalVariantOther": { "allOf": [ { "properties": { "$type": { "enum": ["other"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryDsmSobjectRotationPolicy": { "allOf": [ { "properties": { "deactivate_rotated_key": { "nullable": true, "type": "boolean" }, "effective_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "interval": { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotationInterval" }, "rotate_copied_keys": { "$ref": "#/components/schemas/DiscoveryDsmSobjectRotateCopiedKeys" } }, "type": "object" } ] }, "DiscoveryDsmSobjectState": { "description": "DSM Security object operational state.", "enum": [ "pre_active", "active", "deactivated", "compromised", "destroyed", "deleted", "other", "not_available" ], "type": "string" }, "DiscoveryDsmSobjectType": { "enum": [ "aes", "aria", "des", "des3", "seed", "rsa", "dsa", "ec", "kcdsa", "ec_kcdsa", "bip32", "bls", "opaque", "hmac", "leda_beta", "round5_beta", "secret", "lms", "ml_dsa_beta", "ml_kem_beta", "certificate", "pbe", "other" ], "type": "string" }, "DiscoveryDsmSummaryKeyStatus": { "enum": ["without_expiry", "non_compliant"], "type": "string" }, "DiscoveryDsmSummaryKeyStatusData": { "allOf": [ { "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryEcKcdsaOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryEcOptionsPolicy": { "allOf": [ { "properties": { "elliptic_curves": { "items": { "$ref": "#/components/schemas/DiscoveryEllipticCurve" }, "nullable": true, "type": "array" } }, "type": "object" } ] }, "DiscoveryEllipticCurve": { "description": "Identifies a standardized elliptic curve.", "enum": [ "X25519", "Ed25519", "X448", "SecP192K1", "SecP224K1", "SecP256K1", "NistP192", "NistP224", "NistP256", "NistP384", "NistP521", "Gost256A" ], "type": "string" }, "DiscoveryEllipticCurveParamsMetadata": { "oneOf": [ { "properties": { "named_curve": { "$ref": "#/components/schemas/DiscoveryCurve" } }, "required": ["named_curve"], "title": "DiscoveryEllipticCurveParamsMetadataVariantNamedCurve", "type": "object" }, { "enum": ["implicit_curve"], "title": "DiscoveryEllipticCurveParamsMetadataVariantImplicitCurve", "type": "string" }, { "enum": ["specified_curve"], "title": "DiscoveryEllipticCurveParamsMetadataVariantSpecifiedCurve", "type": "string" } ] }, "DiscoveryEncryptionMetadata": { "description": "Describes whether the cryptographic material is wrapped in a symmetric key -- requiring a passphrase", "oneOf": [ { "enum": ["unencrypted"], "title": "DiscoveryEncryptionMetadataVariantUnencrypted", "type": "string" }, { "properties": { "encrypted": { "$ref": "#/components/schemas/DiscoveryEncryptionMetadataEncrypted" } }, "required": ["encrypted"], "title": "DiscoveryEncryptionMetadataVariantEncrypted", "type": "object" } ] }, "DiscoveryEncryptionMetadataEncrypted": { "allOf": [ { "properties": { "algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" } }, "required": ["algorithm"], "type": "object" } ] }, "DiscoveryExpiryMetrics": { "allOf": [ { "properties": { "expired_count": { "type": "integer" }, "expiring_in_30_days_count": { "type": "integer" } }, "required": ["expired_count", "expiring_in_30_days_count"], "type": "object" } ] }, "DiscoveryExtendedKeyUsage": { "oneOf": [ { "enum": ["server_auth"], "title": "DiscoveryExtendedKeyUsageVariantServerAuth", "type": "string" }, { "enum": ["client_auth"], "title": "DiscoveryExtendedKeyUsageVariantClientAuth", "type": "string" }, { "enum": ["code_signing"], "title": "DiscoveryExtendedKeyUsageVariantCodeSigning", "type": "string" }, { "enum": ["email_protection"], "title": "DiscoveryExtendedKeyUsageVariantEmailProtection", "type": "string" }, { "enum": ["time_stamping"], "title": "DiscoveryExtendedKeyUsageVariantTimeStamping", "type": "string" }, { "enum": ["ocsp_signing"], "title": "DiscoveryExtendedKeyUsageVariantOcspSigning", "type": "string" }, { "properties": { "unknown": { "description": "Unknown value, will contain the OID that was found", "type": "string" } }, "required": ["unknown"], "title": "DiscoveryExtendedKeyUsageVariantUnknown", "type": "object" } ] }, "DiscoveryExtendedUsage": { "allOf": [ { "properties": { "allowed_usages": { "items": { "$ref": "#/components/schemas/DiscoveryExtendedKeyUsage" }, "nullable": true, "type": "array" }, "rejected_usages": { "items": { "$ref": "#/components/schemas/DiscoveryExtendedKeyUsage" }, "nullable": true, "type": "array" } }, "type": "object" } ] }, "DiscoveryFileInfo": { "allOf": [ { "description": "File info", "properties": { "file_path": { "type": "string" }, "file_permissions": { "$ref": "#/components/schemas/DiscoveryPermissions" }, "file_size": { "nullable": true, "type": "integer" }, "modification_unix_millis": { "type": "integer" } }, "required": ["file_path", "modification_unix_millis"], "type": "object" } ] }, "DiscoveryFilesystemScannedObject": { "allOf": [ { "properties": { "file_info": { "$ref": "#/components/schemas/DiscoveryFileInfo" }, "metadata": { "$ref": "#/components/schemas/DiscoveryCryptographicMetadata" } }, "required": ["file_info", "metadata"], "type": "object" } ] }, "DiscoveryFpeCharSet": { "allOf": [ { "items": { "items": { "maxLength": 1, "minLength": 1, "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "type": "array" } ], "description": "The alphabet to use for an encrypted portion of a complex tokenization data type.\nCharacters should be specified as a list of pairs, where each pair [a, b] represents the\nrange of Unicode code points from a to b, with both bounds being inclusive. A single\ncode point can be specified as [c, c].\n\nNormally, each character is assigned a numeric value for FF1. The first character is\nassigned a value of 0, and subsequent characters are assigned values of 1, 2, and so on,\nup to the size of the alphabet. Note that the order of the ranges matters; characters\nappearing in later ranges are assigned higher numerical values compared to earlier\ncharacters. For instance, in the FpeCharSet [['a', 'z'], ['0', '9']], the digits '0' to\n'9' are assigned values from 26 to 35, since they are listed after the 'a' to 'z' range.\n\nIn any case, ranges should not overlap with each other, and should not contain surrogate\ncode points." }, "DiscoveryFpeChecksum": { "enum": ["luhn"], "type": "string" }, "DiscoveryFpeCode": { "allOf": [ { "description": "A set of words, repeated an amount of times.", "properties": { "max_repetitions": { "nullable": true, "type": "integer" }, "min_repetitions": { "nullable": true, "type": "integer" }, "words": { "$ref": "#/components/schemas/DiscoveryFpeWords" } }, "required": ["words"], "type": "object" } ] }, "DiscoveryFpeCompoundPart": { "description": "Structure of a compound portion of a complex tokenization data type, itself composed of\nsmaller parts.", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryFpeCompoundPartOr" }, { "$ref": "#/components/schemas/DiscoveryFpeCompoundPartConcat" }, { "$ref": "#/components/schemas/DiscoveryFpeCompoundPartMultiple" } ] }, "DiscoveryFpeCompoundPartConcat": { "allOf": [ { "description": "Represents a concatenation of multiple structures (in a particular order).", "properties": { "concat": { "description": "The actual subparts that make up this compound part, in order.", "items": { "$ref": "#/components/schemas/DiscoveryFpeDataPart" }, "type": "array" }, "constraints": { "$ref": "#/components/schemas/DiscoveryFpeConstraints" }, "mask": { "description": "Whether the entire concat should be masked when doing masked decryption. If this is\nset, any descendant subparts cannot contain any mask-related fields set.", "nullable": true, "type": "boolean" }, "max_length": { "description": "The maximum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "min_length": { "description": "The minimum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "preserve": { "description": "Whether the entire concat should be preserved as-is (i.e., not tokenized). If this is\nset, any descendant subparts cannot contain any preserve-related fields set.", "nullable": true, "type": "boolean" } }, "required": ["concat"], "type": "object" } ] }, "DiscoveryFpeCompoundPartMultiple": { "allOf": [ { "description": "Indicates a part that is possibly repeated multiple times.\n\nImplementation note: the backend parser is locally \"greedy\" and will attempt to match\nas many repetitions as possible. If this later results in an invalid parse of the rest\nof the input, the backend ***will not backtrack*** and will simply return with an error.", "properties": { "constraints": { "$ref": "#/components/schemas/DiscoveryFpeConstraints" }, "mask": { "description": "Whether the entire Multiple should be masked when doing masked decryption. If this is\nset, the `multiple` subpart and its descendants cannot contain any mask-related fields\nset.", "nullable": true, "type": "boolean" }, "max_length": { "description": "The maximum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "max_repetitions": { "description": "The maximum number of times the subpart may occur. (A value of 1 marks a single\noccurrence.)", "nullable": true, "type": "integer" }, "min_length": { "description": "The minimum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "min_repetitions": { "description": "The minimum number of times the subpart may occur. (A value of 1 marks a single\noccurrence.)", "nullable": true, "type": "integer" }, "multiple": { "$ref": "#/components/schemas/DiscoveryFpeDataPart" }, "preserve": { "description": "Whether the entire Multiple should be preserved as-is (i.e., not tokenized). If this\nis set, the `multiple` subpart and its descendants cannot contain any preserve-related\nfields set.", "nullable": true, "type": "boolean" } }, "required": ["multiple"], "type": "object" } ] }, "DiscoveryFpeCompoundPartOr": { "allOf": [ { "description": "Represents an OR of multiple structures.\n\nImplementation note: an OR is _not_ a union of `FpeDataPart`s. Rather, when parsing\nthe input, the backend will simply choose the first subpart that matches the current\nportion of the input, and tokenize/detokenize accordingly. If that choice results in\nan invalid parse of the rest of the input, the backend ***will not backtrack*** and\nwill simply return with an error.", "properties": { "constraints": { "$ref": "#/components/schemas/DiscoveryFpeConstraints" }, "mask": { "description": "Whether the entire OR should be masked when doing masked decryption. If this is set,\nany descendant subparts cannot contain any mask-related fields set.", "nullable": true, "type": "boolean" }, "max_length": { "description": "The maximum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "min_length": { "description": "The minimum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "or": { "description": "The actual subparts that make up this compound part.", "items": { "$ref": "#/components/schemas/DiscoveryFpeDataPart" }, "type": "array" }, "preserve": { "description": "Whether the entire OR should be preserved as-is (i.e., not tokenized). If this is\nset, any descendant subparts cannot contain any preserve-related fields set.", "nullable": true, "type": "boolean" } }, "required": ["or"], "type": "object" } ] }, "DiscoveryFpeConstraints": { "allOf": [ { "description": "Constraints on a portion of a complex tokenization data type.", "properties": { "applies_to": { "$ref": "#/components/schemas/DiscoveryFpeConstraintsApplicability" }, "date": { "$ref": "#/components/schemas/DiscoveryFpeDateConstraint" }, "luhn_check": { "description": "Whether the token part contains a checksum that satisfies the Luhn formula. It is an\nerror to apply this constraint to non-numeric parts, or to have an encrypted part be\nunder more than one Luhn check constraint. Also, if an encrypted part has a Luhn check\nconstraint applied to it and may contain at least one digit that is not preserved, it\nmust not specify any other constraints.", "nullable": true, "type": "boolean" }, "num_gt": { "description": "Number that the token part should be greater than.\n\nThis constraint can only be specified on (non-compound) numeric encrypted parts\nguaranteed to preserve either everything or nothing at all. (For example, if an\nencrypted part consists of 5 to 10 digits, a `preserve` list that covers only the\nfirst five digits is not guaranteed to preserve everything, because if the input\nhappens to be six or more digits long, there will be at least one digit that\nremains unpreserved.)", "nullable": true, "type": "integer" }, "num_lt": { "description": "Number that the token part should be smaller than.\n\nThis constraint can only be specified on (non-compound) numeric encrypted parts\nguaranteed to preserve either everything or nothing at all. (For example, if an\nencrypted part consists of 5 to 10 digits, a `preserve` list that covers only the\nfirst five digits is not guaranteed to preserve everything, because if the input\nhappens to be six or more digits long, there will be at least one digit that\nremains unpreserved.)", "nullable": true, "type": "integer" }, "num_ne": { "description": "Numbers that the token part should not be equal to. It is an error to apply this\nconstraint to non-numeric parts.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" } ] }, "DiscoveryFpeConstraintsApplicability": { "description": "A structure indicating which subparts to which to apply a set of constraints.", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAll" }, { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryFpeConstraintsApplicability" }, "description": "An object representing the individual subparts that the constraints should apply to. This\nis a BTreeMap where for each key-value pair, the key represents the \"index\" of the subpart\n(with the first subpart having index 0), and the value is an FpeConstraintsApplicability\ninstance. Note that a Multiple part only allows for one possible key-value pair, since it\nonly contains one subpart. For Concat parts, the key is the zero-based index of the subpart\nin the `concat` field, and for Multiple parts, this is always 0 (due to a Multiple having\nonly one subpart).\n\nThis cannot be used with OR parts; instead, specify constraints individually on each\nrelevant subpart.", "type": "object" } ] }, "DiscoveryFpeDataPart": { "description": "Structure for specifying (part of) a complex tokenization data type.", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryFpeEncryptedPart" }, { "$ref": "#/components/schemas/DiscoveryFpeDataPartLiteral" }, { "$ref": "#/components/schemas/DiscoveryFpeCompoundPart" } ] }, "DiscoveryFpeDataPartLiteral": { "allOf": [ { "description": "A section of the data type that is not to be tokenized (e.g., a delimiter).\n\nUnlike preserved characters, literal characters are not used for FF1 tweaks.", "properties": { "literal": { "description": "The list of possible strings that make up this literal portion of the token.\nFor example, if a delimiter can either be a space or a dash, the list would\nbe `[\" \", \"-\"]`.\n\nImplementation note: the backend will pick the first choice that matches when\nwhen parsing the input. If this results in an invalid parse of the rest of the\ninput, the backend ***will not backtrack*** and will simply return with an error.", "items": { "type": "string" }, "type": "array" } }, "required": ["literal"], "type": "object" } ] }, "DiscoveryFpeDate": { "description": "A structure for specifying a token part representing a date that occurs after a specified date\nand/or occurs before a specified date. Depending on the subparts that make up the date, one of\nthe three options is used.", "oneOf": [ { "properties": { "dmy_date": { "$ref": "#/components/schemas/DiscoveryFpeDateDayMonthYear" } }, "required": ["dmy_date"], "title": "DiscoveryFpeDateVariantDayMonthYear", "type": "object" }, { "properties": { "month_day_date": { "$ref": "#/components/schemas/DiscoveryFpeDateMonthDay" } }, "required": ["month_day_date"], "title": "DiscoveryFpeDateVariantMonthDay", "type": "object" }, { "properties": { "month_year_date": { "$ref": "#/components/schemas/DiscoveryFpeDateMonthYear" } }, "required": ["month_year_date"], "title": "DiscoveryFpeDateVariantMonthYear", "type": "object" } ] }, "DiscoveryFpeDateConstraint": { "description": "Possible date-related constraint types for a portion of a complex tokenization data type.", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryFpeDate" }, { "$ref": "#/components/schemas/DiscoveryFpeDatePart" } ] }, "DiscoveryFpeDateDayMonthYear": { "allOf": [ { "description": "Represents a date that consists of a Month subpart, a Day subpart, and a Year subpart. The\nYear part is allowed to be preserved, and the Day and Month parts are allowed to be\npreserved together. (The Day part cannot be preserved if the Month part is not, and vice\nversa.)", "properties": { "after": { "$ref": "#/components/schemas/DiscoveryFpeDayMonthYearDate" }, "before": { "$ref": "#/components/schemas/DiscoveryFpeDayMonthYearDate" } }, "type": "object" } ] }, "DiscoveryFpeDateMonthDay": { "allOf": [ { "description": "Represents a date that consists of a Month subpart and a Day subpart. It is an error to\npreserve only the Month part or the Day part.", "properties": { "after": { "$ref": "#/components/schemas/DiscoveryFpeDayMonthDate" }, "before": { "$ref": "#/components/schemas/DiscoveryFpeDayMonthDate" } }, "type": "object" } ] }, "DiscoveryFpeDateMonthYear": { "allOf": [ { "description": "Represents a date that consists of a Month subpart and a Year subpart. The Year part is\nallowed to be preserved; however, the Month part cannot be preserved by itself.", "properties": { "after": { "$ref": "#/components/schemas/DiscoveryFpeMonthYearDate" }, "before": { "$ref": "#/components/schemas/DiscoveryFpeMonthYearDate" } }, "type": "object" } ] }, "DiscoveryFpeDatePart": { "description": "Possible date-related constraint types that do not form a complete date (by themselves) for a\ncomplex tokenization data type.", "enum": ["month", "day", "year"], "type": "string" }, "DiscoveryFpeDayMonthDate": { "allOf": [ { "description": "A structure for specifying a particular date consisting of a day and a month, for use in an\nFpeDate structure.", "properties": { "day": { "description": "The day, which should be an integer from 1 to either 29, 30, or 31, depending on the month\nand year. Here, February is treated as having 29 days.", "maximum": 255, "minimum": 0, "type": "integer" }, "month": { "description": "The month, which should be an integer from 1 to 12.", "maximum": 255, "minimum": 0, "type": "integer" } }, "required": ["month", "day"], "type": "object" } ] }, "DiscoveryFpeDayMonthYearDate": { "allOf": [ { "description": "A structure for specifying a particular date consisting of a day, month, and year, for use in\nan FpeDate structure.", "properties": { "day": { "description": "The day, which should be an integer from 1 to either 28, 29, 30, or 31, depending on the\nmonth and year.", "maximum": 255, "minimum": 0, "type": "integer" }, "month": { "description": "The month, which should be an integer from 1 to 12.", "maximum": 255, "minimum": 0, "type": "integer" }, "year": { "description": "The year, which should be an integer less than 100000. Zero is treated as a leap year.", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["year", "month", "day"], "type": "object" } ] }, "DiscoveryFpeEncryptedPart": { "allOf": [ { "description": "Structure of a tokenized portion of a complex tokenization data type.\n\nImplementation note: the backend parser is locally \"greedy\" and will attempt to match\nas many characters as possible. If this later results in an invalid parse of the rest\nof the input, the backend ***will not backtrack*** and will simply return with an error.", "properties": { "char_set": { "$ref": "#/components/schemas/DiscoveryFpeCharSet" }, "cipher_char_set": { "$ref": "#/components/schemas/DiscoveryFpeCharSet" }, "constraints": { "$ref": "#/components/schemas/DiscoveryFpeConstraints" }, "mask": { "$ref": "#/components/schemas/DiscoveryFpePreserveMask" }, "max_length": { "description": "The maximum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "min_length": { "description": "The minimum allowed length for this part (in chars).", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "preserve": { "$ref": "#/components/schemas/DiscoveryFpePreserveMask" } }, "required": ["min_length", "max_length", "char_set"], "type": "object" } ] }, "DiscoveryFpeFormatV2": { "allOf": [ { "description": "The second generation of Fortanix Tokenization scheme.", "properties": { "input_processing": { "$ref": "#/components/schemas/DiscoveryFpeInputProcessing" }, "mode": { "$ref": "#/components/schemas/DiscoveryFpeTokenizeMode" }, "variants": { "description": "A token is accepted if it is accepted by any of these variants. Note\ntokenization results depend on the order of this list.", "items": { "$ref": "#/components/schemas/DiscoveryFpeVariant" }, "type": "array" } }, "required": ["variants"], "type": "object" } ] }, "DiscoveryFpeGroup": { "allOf": [ { "description": "A concatenation of codes, that can be repeated an amount of times. An\namount of leading and trailing characters can be preserved, this is,\nunmodified by tokenization.", "properties": { "codes": { "items": { "$ref": "#/components/schemas/DiscoveryFpeCode" }, "type": "array" }, "max_repetitions": { "nullable": true, "type": "integer" }, "min_repetitions": { "description": "A group cannot be omitted, thus this field must be positive if present.", "nullable": true, "type": "integer" }, "preserve": { "description": "Amount of leading and trailing characters to preserve in this group.\nPreserved characters are the leading/trailing characters of the whole\ngroup, not individual repetitions.", "items": { "type": "integer" }, "maxItems": 2, "minItems": 2, "nullable": true, "type": "array" } }, "required": ["codes"], "type": "object" } ] }, "DiscoveryFpeInputProcessing": { "description": "Options to apply some pre- and post-processing to the input.", "enum": ["strip_unknown", "passthrough_unknown"], "type": "string" }, "DiscoveryFpeMonthYearDate": { "allOf": [ { "description": "A structure for specifying a particular date consisting of a month and a year, for use in an\nFpeDate structure.", "properties": { "month": { "description": "The month, which should be an integer from 1 to 12.", "maximum": 255, "minimum": 0, "type": "integer" }, "year": { "description": "The year, which should be an integer less than 100000. Zero is treated as a leap year.", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["year", "month"], "type": "object" } ] }, "DiscoveryFpeOptions": { "description": "FPE-specific options (for specifying the format of the\ndata to be encrypted)", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryFpeOptionsBasic" }, { "$ref": "#/components/schemas/DiscoveryFpeOptionsAdvanced" }, { "$ref": "#/components/schemas/DiscoveryFpeOptionsV2" } ] }, "DiscoveryFpeOptionsAdvanced": { "allOf": [ { "description": "Advanced FPE options. It is recommended to use this for\nspecifying any FPE options, as it is more expressive than\nFpeOptionsBasic.", "properties": { "description": { "description": "The user-provided name for the data type.", "nullable": true, "type": "string" }, "format": { "$ref": "#/components/schemas/DiscoveryFpeDataPart" } }, "required": ["format"], "type": "object" } ] }, "DiscoveryFpeOptionsBasic": { "allOf": [ { "description": "Basic FPE-specific options. This is suitable for simple datatypes\nthat consist of ASCII digits, or ASCII digits and uppercase letters.", "properties": { "luhn_check": { "description": "Whether the encrypted/decrypted data contains a checksum digit that satisfies the Luhn\nformula. (The output ciphertext/plaintext will also contain a Luhn checksum digit.)", "nullable": true, "type": "boolean" }, "mask": { "description": "The list of indices of characters to be masked while performing masked decryption.\nIndices are Python-like; i.e., nonnegative indices index from the beginning of the input\n(where 0 is the first character), and negative indices index from the end of the input.\n(where -1 is the last character, -2 is second to last, and so on).", "items": { "format": "int64", "type": "integer" }, "nullable": true, "type": "array" }, "max_length": { "description": "The maximum allowed length for the input data.", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "min_length": { "description": "The minimum allowed length for the input data.", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "name": { "description": "The user-provided name for the data type that represents the input data.", "nullable": true, "type": "string" }, "preserve": { "description": "The list of indices of characters to be preserved while performing encryption/decryption.\nIndices are Python-like; i.e., nonnegative indices index from the beginning of the input\n(where 0 is the first character), and negative indices index from the end of the input.\n(where -1 is the last character, -2 is second to last, and so on).\n\nAny preserved characters will be concatenated together and used as an FF1 tweak. For example,\nif the input data is \"abcd\", and the first and last characters are to be preserved, the FF1\ntweak will be the ASCII bytes of the string \"ad\".", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "radix": { "description": "The FPE base for the input data (i.e., the size of the character\nset of the datatype). This must be an integer from 2 to 36.\n\nThis also implicitly defines the alphabet of the datatype. A base\nfrom 2 to 10 implies ASCII digits (e.g., a radix of 3 can be used\nto represent a ternary string), and a base from 11 to 36 implies\nASCII digits and uppercase letters (e.g., a radix of 16 can be", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["radix", "min_length", "max_length", "preserve"], "type": "object" } ] }, "DiscoveryFpeOptionsV2": { "allOf": [ { "properties": { "description": { "nullable": true, "type": "string" }, "format_v2": { "$ref": "#/components/schemas/DiscoveryFpeFormatV2" } }, "required": ["format_v2"], "type": "object" } ] }, "DiscoveryFpePreserveMask": { "description": "A structure indicating which indices in an encrypted part to mask or preserve.", "oneOf": [ { "$ref": "#/components/schemas/DiscoveryAll" }, { "description": "Indicates that only certain characters are to be preserved or masked. Indices are\nPython-like; i.e., negative indices index from the end of the token portion, with\nindex -1 denoting the last character. (Indicating that nothing should be preserved\nor masked can be done via an empty list, which is the default value for this enum.)", "items": { "format": "int64", "type": "integer" }, "type": "array" } ] }, "DiscoveryFpeSection": { "allOf": [ { "description": "A concatenation of groups, optionally including a checksum.", "properties": { "checksum": { "$ref": "#/components/schemas/DiscoveryFpeChecksum" }, "groups": { "items": { "$ref": "#/components/schemas/DiscoveryFpeGroup" }, "type": "array" } }, "required": ["groups"], "type": "object" } ] }, "DiscoveryFpeTokenizeMode": { "description": "How to tokenize a given input. The most secure option is \"PreserveFormat\".", "enum": ["preserve_format", "preserve_variant", "preserve_length"], "type": "string" }, "DiscoveryFpeVariant": { "allOf": [ { "description": "A concatenation of sections.", "properties": { "sections": { "items": { "$ref": "#/components/schemas/DiscoveryFpeSection" }, "type": "array" } }, "required": ["sections"], "type": "object" } ] }, "DiscoveryFpeWords": { "description": "A set of fixed-length strings.", "oneOf": [ { "properties": { "integer_ranges": { "$ref": "#/components/schemas/DiscoveryFpeWordsIntegerRanges" } }, "required": ["integer_ranges"], "title": "DiscoveryFpeWordsVariantIntegerRanges", "type": "object" }, { "properties": { "alphabet": { "$ref": "#/components/schemas/DiscoveryFpeCharSet" } }, "required": ["alphabet"], "title": "DiscoveryFpeWordsVariantAlphabet", "type": "object" }, { "properties": { "custom": { "$ref": "#/components/schemas/DiscoveryFpeWordsCustom" } }, "required": ["custom"], "title": "DiscoveryFpeWordsVariantCustom", "type": "object" } ] }, "DiscoveryFpeWordsCustom": { "allOf": [ { "properties": { "list": { "description": "Examples: {\"john\", \"jane\"}, {\".\", \"-\", \"_\", \"@\", \" \"}", "items": { "type": "string" }, "type": "array" } }, "required": ["list"], "type": "object" } ] }, "DiscoveryFpeWordsIntegerRanges": { "allOf": [ { "description": "A union of positive integer ranges.\n\n```plain\nExamples: [[0, 400], [402, 1000]]\n= {0000, 0001, ..., 0400, 0402, ..., 1000}\n\n[[1,3], [49, 50]] with optional padding of length 8\n= {00000001, 00000002, 00000003, 00000049, 00000050}\n(accepts 1, 01, 00002, 49, 000050, etc)\n```", "properties": { "padding_required": { "description": "If this field is true, this set accepts only numeric strings\npadded to the length given by the maximum integer in the range\nset.", "type": "boolean" }, "ranges": { "items": { "items": { "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "type": "array" } }, "required": ["ranges", "padding_required"], "type": "object" } ] }, "DiscoveryGetAllConnectionsMetadata": { "allOf": [ { "properties": { "filtered_count": { "description": "The amount returned with the filter applied", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "total_count": { "description": "The total number of Connection objects that exist", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["total_count", "filtered_count"], "type": "object" } ] }, "DiscoveryGetAllConnectionsParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryGetAllConnectionsResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryConnection" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryGetAllConnectionsMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoveryGetAllPoliciesMetadata": { "allOf": [ { "properties": { "filtered_count": { "description": "The amount returned with the filter applied", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "total_count": { "description": "The total number of Policy objects exist", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["total_count", "filtered_count"], "type": "object" } ] }, "DiscoveryGetAllPoliciesParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryGetAllPoliciesResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryPolicy" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryGetAllPoliciesMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoveryGetAllScansResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryScan" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryHmacOptionsPolicy": { "allOf": [ { "properties": { "minimum_key_length": { "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" } }, "type": "object" } ] }, "DiscoveryHostInfo": { "allOf": [ { "description": "Host info for the machine sending the data", "properties": { "hostname": { "type": "string" }, "id": { "type": "string" }, "ips": { "items": { "type": "string" }, "type": "array" }, "os_string": { "type": "string" } }, "required": ["id", "hostname", "ips", "os_string"], "type": "object" } ] }, "DiscoveryInventoryObject": { "allOf": [ { "description": "InventoryObject -- represents the user provided information to be added to an external computational resource [ScanInventoryObject]", "properties": { "acct_id": { "description": "KI account extension id", "format": "uuid", "type": "string" }, "connection_id": { "description": "KI account's connection id", "format": "uuid", "type": "string" }, "external_id": { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalId" }, "group_id": { "description": "KI group extension id", "format": "uuid", "type": "string" }, "id": { "description": "generated by KI. remains static throughout lifetime of account", "format": "uuid", "type": "string" }, "last_scan_inventory_object": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectReference" }, "object_info": { "$ref": "#/components/schemas/DiscoveryInventoryObjectInfo" } }, "required": [ "acct_id", "connection_id", "external_id", "group_id", "id", "last_scan_inventory_object", "object_info" ], "type": "object" } ] }, "DiscoveryInventoryObjectExternalId": { "description": "an enum that maps to unique identifier provided by Cloud/Onprem", "discriminator": { "mapping": { "aws": "DiscoveryInventoryObjectExternalIdVariantAws", "azure": "DiscoveryInventoryObjectExternalIdVariantAzure", "dsm": "DiscoveryInventoryObjectExternalIdVariantDsm", "on_prem": "DiscoveryInventoryObjectExternalIdVariantOnPrem", "on_prem_fs": "DiscoveryInventoryObjectExternalIdVariantOnPremFs" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdVariantAws" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdVariantAzure" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdVariantDsm" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdVariantOnPrem" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdVariantOnPremFs" } ] }, "DiscoveryInventoryObjectExternalIdAws": { "allOf": [ { "properties": { "arn": { "description": "fully qualified resource id as defined by AWS", "type": "string" }, "service": { "$ref": "#/components/schemas/DiscoveryAwsService" } }, "required": ["arn", "service"], "type": "object" } ] }, "DiscoveryInventoryObjectExternalIdAzure": { "allOf": [ { "properties": { "resource_id": { "description": "fully qualified resource id as defined by Azure", "type": "string" }, "service": { "$ref": "#/components/schemas/DiscoveryAzureService" } }, "required": ["resource_id", "service"], "type": "object" } ] }, "DiscoveryInventoryObjectExternalIdDsm": { "allOf": [ { "properties": { "deployment": { "$ref": "#/components/schemas/DiscoveryDsmDeployment" }, "id": { "format": "uuid", "type": "string" }, "resource_type": { "$ref": "#/components/schemas/DiscoveryDsmResourceType" } }, "required": ["id", "deployment", "resource_type"], "type": "object" } ] }, "DiscoveryInventoryObjectExternalIdOnPrem": { "allOf": [ { "properties": { "resource_id": { "description": "unique id", "type": "string" }, "resource_type": { "$ref": "#/components/schemas/DiscoveryOnPremService" }, "service_uri": { "description": "Db/filesystem uri which yielded this resource", "type": "string" } }, "required": ["resource_id", "service_uri", "resource_type"], "type": "object" } ] }, "DiscoveryInventoryObjectExternalIdOnPremFs": { "allOf": [ { "properties": { "file_path": { "type": "string" }, "machine_id": { "type": "string" } }, "required": ["machine_id", "file_path"], "type": "object" } ] }, "DiscoveryInventoryObjectExternalIdVariantAws": { "allOf": [ { "properties": { "$type": { "enum": ["aws"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdAws" } ] }, "DiscoveryInventoryObjectExternalIdVariantAzure": { "allOf": [ { "properties": { "$type": { "enum": ["azure"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdAzure" } ] }, "DiscoveryInventoryObjectExternalIdVariantDsm": { "allOf": [ { "properties": { "$type": { "enum": ["dsm"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdDsm" } ] }, "DiscoveryInventoryObjectExternalIdVariantOnPrem": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdOnPrem" } ] }, "DiscoveryInventoryObjectExternalIdVariantOnPremFs": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_fs"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryInventoryObjectExternalIdOnPremFs" } ] }, "DiscoveryInventoryObjectInfo": { "allOf": [ { "properties": { "ownership_details": { "$ref": "#/components/schemas/DiscoveryInventoryObjectOwnershipDetails" } }, "type": "object" } ] }, "DiscoveryInventoryObjectOwner": { "allOf": [ { "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["name", "email"], "type": "object" } ] }, "DiscoveryInventoryObjectOwnershipDetails": { "allOf": [ { "properties": { "description": { "nullable": true, "type": "string" }, "primary_owner": { "$ref": "#/components/schemas/DiscoveryInventoryObjectOwner" }, "secondary_owner": { "$ref": "#/components/schemas/DiscoveryInventoryObjectOwner" } }, "required": ["primary_owner"], "type": "object" } ] }, "DiscoveryInventoryObjectsParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryInventoryObjectsResponse": { "allOf": [ { "properties": { "items": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryInventoryObject" }, "type": "object" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryJweHeaderMetadata": { "allOf": [ { "properties": { "agreement_partyuinfo": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "agreement_partyvinfo": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "algorithm": { "nullable": true, "type": "string" }, "audience": { "nullable": true, "type": "string" }, "compression": { "nullable": true, "type": "string" }, "content_encryption": { "nullable": true, "type": "string" }, "content_type": { "nullable": true, "type": "string" }, "critical": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "issuer": { "nullable": true, "type": "string" }, "jwk": { "$ref": "#/components/schemas/DiscoveryCryptographicMetadata" }, "jwk_set_url": { "nullable": true, "type": "string" }, "key_id": { "nullable": true, "type": "string" }, "nonce": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "subject": { "nullable": true, "type": "string" }, "token_type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" }, "x509_certificate_chain": { "items": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" }, "nullable": true, "type": "array" }, "x509_certificate_sha1_thumbprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "x509_certificate_sha256_thumbprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "x509_url": { "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryJwsHeaderMetadata": { "allOf": [ { "properties": { "algorithm": { "nullable": true, "type": "string" }, "content_type": { "nullable": true, "type": "string" }, "critical": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "jwk": { "$ref": "#/components/schemas/DiscoveryCryptographicMetadata" }, "jwk_set_url": { "nullable": true, "type": "string" }, "key_id": { "nullable": true, "type": "string" }, "nonce": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "token_type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" }, "x509_certificate_chain": { "items": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" }, "nullable": true, "type": "array" }, "x509_certificate_sha1_thumbprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "x509_certificate_sha256_thumbprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" }, "x509_url": { "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryJwtHeader": { "oneOf": [ { "properties": { "jws_header": { "$ref": "#/components/schemas/DiscoveryJwsHeaderMetadata" } }, "required": ["jws_header"], "title": "DiscoveryJwtHeaderVariantJwsHeader", "type": "object" }, { "properties": { "protected_jws_header": { "$ref": "#/components/schemas/DiscoveryJwsHeaderMetadata" } }, "required": ["protected_jws_header"], "title": "DiscoveryJwtHeaderVariantProtectedJwsHeader", "type": "object" }, { "properties": { "jwe_header": { "$ref": "#/components/schemas/DiscoveryJweHeaderMetadata" } }, "required": ["jwe_header"], "title": "DiscoveryJwtHeaderVariantJweHeader", "type": "object" }, { "properties": { "protected_jwe_header": { "$ref": "#/components/schemas/DiscoveryJweHeaderMetadata" } }, "required": ["protected_jwe_header"], "title": "DiscoveryJwtHeaderVariantProtectedJweHeader", "type": "object" } ] }, "DiscoveryJwtMetadata": { "allOf": [ { "properties": { "header": { "$ref": "#/components/schemas/DiscoveryJwtHeader" }, "signature": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" } }, "required": ["header", "signature"], "type": "object" } ] }, "DiscoveryKcdsaOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryKeyAvailability": { "description": "This enum will be used for denoting key availability for all services in all cloud providers.\nEach variant corresponds to different states of key used to encrypt the service. If a service is\nnot encrypted, the key will me marked as Unknown", "enum": [ "available", "soft_deleted", "purged", "cross_account", "unknown" ], "type": "string" }, "DiscoveryKeyEncryptUsageDetails": { "allOf": [ { "properties": { "service_count": { "type": "integer" } }, "required": ["service_count"], "type": "object" } ] }, "DiscoveryKeyOperations": { "description": "Operations allowed to be performed on a given key.\n\n\n\n SIGN:\n If this is set, the key can be used to for signing.\n\n\n VERIFY:\n If this is set, the key can used for verifying a signature.\n\n\n ENCRYPT:\n If this is set, the key can be used for encryption.\n\n\n DECRYPT:\n If this is set, the key can be used for decryption.\n\n\n WRAPKEY:\n If this is set, the key can be used wrapping other keys.\n The key being wrapped must have the EXPORT operation enabled.\n\n\n UNWRAPKEY:\n If this is set, the key can be used to unwrap a wrapped key.\n\n\n DERIVEKEY:\n If this is set, the key can be used to derive another key.\n\n\n TRANSFORM:\n If this is set, the key can be transformed.\n\n\n MACGENERATE:\n If this is set, the key can be used to compute a cryptographic\n Message Authentication Code (MAC) on a message.\n\n\n MACVERIFY:\n If they is set, the key can be used to verify a MAC.\n\n\n EXPORT:\n If this is set, the value of the key can be retrieved\n with an authenticated request. This shouldn't be set unless\n required. It is more secure to keep the key's value inside DSM only.\n\n\n APPMANAGEABLE:\n Without this operation, management operations like delete, destroy,\n rotate, activate, restore, revoke, revert, update, remove_private, etc.\n cannot be performed by a crypto App.\n A user with access or admin app can still perform these operations.\n This option is only relevant for crypto apps.\n\n\n HIGHVOLUME:\n If this is set, audit logs will not be recorded for the key.\n High volume here tries to signify a key that is being used a lot\n and will produce lots of logs. Setting this operation disables\n audit logs for the key.\n\n\n AGREEKEY:\n If this is set, the key can be used for key agreement.\n Both the private and public key should have this option enabled\n to perform an agree operation.\n\n\n ENCAPSULATE:\n If this is set, the key can be used for key encapsulation. The\n result is a new symmetric key and a ciphertext.\n\n\n DECAPSULATE:\n If this is set, the key can be used for key decapsulation. If\n decapsulation succeeds, the result is a new symmetric key.\n\n", "enum": [ "SIGN", "VERIFY", "ENCRYPT", "DECRYPT", "WRAPKEY", "UNWRAPKEY", "DERIVEKEY", "TRANSFORM", "MACGENERATE", "MACVERIFY", "EXPORT", "APPMANAGEABLE", "HIGHVOLUME", "AGREEKEY", "ENCAPSULATE", "DECAPSULATE" ], "type": "string" }, "DiscoveryKeyPolicyId": { "discriminator": { "mapping": { "aws_grant_id": "DiscoveryKeyPolicyIdVariantAwsGrantId", "aws_key_policy_sid": "DiscoveryKeyPolicyIdVariantAwsKeyPolicySid" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryKeyPolicyIdVariantAwsKeyPolicySid" }, { "$ref": "#/components/schemas/DiscoveryKeyPolicyIdVariantAwsGrantId" } ] }, "DiscoveryKeyPolicyIdAwsGrantId": { "allOf": [ { "properties": { "id": { "type": "string" } }, "required": ["id"], "type": "object" } ] }, "DiscoveryKeyPolicyIdAwsKeyPolicySid": { "allOf": [ { "properties": { "sid": { "type": "string" } }, "required": ["sid"], "type": "object" } ] }, "DiscoveryKeyPolicyIdVariantAwsGrantId": { "allOf": [ { "properties": { "$type": { "enum": ["aws_grant_id"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryKeyPolicyIdAwsGrantId" } ] }, "DiscoveryKeyPolicyIdVariantAwsKeyPolicySid": { "allOf": [ { "properties": { "$type": { "enum": ["aws_key_policy_sid"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryKeyPolicyIdAwsKeyPolicySid" } ] }, "DiscoveryKeyUsage": { "enum": ["encrypt", "unused"], "type": "string" }, "DiscoveryKeyUsageDetails": { "allOf": [ { "properties": { "encrypt": { "$ref": "#/components/schemas/DiscoveryKeyEncryptUsageDetails" } }, "type": "object" } ] }, "DiscoveryLegacyKeyPolicy": { "enum": ["allowed", "prohibited", "unprotect_only"], "type": "string" }, "DiscoveryLmsOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryMgfPolicy": { "description": "MGF policy.", "oneOf": [ { "properties": { "mgf1": { "$ref": "#/components/schemas/DiscoveryMgfPolicyMgf1" } }, "required": ["mgf1"], "title": "DiscoveryMgfPolicyVariantMgf1", "type": "object" } ] }, "DiscoveryMgfPolicyMgf1": { "allOf": [ { "properties": { "hash": { "$ref": "#/components/schemas/DiscoveryDigestAlgorithm" } }, "type": "object" } ] }, "DiscoveryMlDsaOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryMlKemOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryOnPremCbomComponentType": { "enum": [ "algorithm", "protocol", "certificate", "private-key", "public-key", "secret-key", "key", "ciphertext", "signature", "digest", "initialization-vector", "nonce", "seed", "salt", "shared-secret", "tag", "additional-data", "password", "credential", "token", "other", "unknown" ], "type": "string" }, "DiscoveryOnPremConnection": { "allOf": [ { "properties": { "config": { "$ref": "#/components/schemas/DiscoveryOnPremConnectionConfig" }, "on_prem_details": { "$ref": "#/components/schemas/DiscoveryOnPremDetails" }, "state": { "$ref": "#/components/schemas/DiscoveryOnPremConnectionState" } }, "required": ["config", "state"], "type": "object" } ] }, "DiscoveryOnPremConnectionAuth": { "discriminator": { "mapping": { "certificate": "DiscoveryOnPremConnectionAuthVariantCertificate", "secret": "DiscoveryOnPremConnectionAuthVariantSecret" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryOnPremConnectionAuthVariantCertificate" }, { "$ref": "#/components/schemas/DiscoveryOnPremConnectionAuthVariantSecret" } ] }, "DiscoveryOnPremConnectionAuthVariantCertificate": { "allOf": [ { "properties": { "$type": { "enum": ["certificate"], "type": "string" }, "$value": { "format": "byte", "type": "string" } }, "required": ["$type", "$value"], "type": "object" } ] }, "DiscoveryOnPremConnectionAuthVariantSecret": { "allOf": [ { "properties": { "$type": { "enum": ["secret"], "type": "string" }, "$value": { "type": "string" } }, "required": ["$type", "$value"], "type": "object" } ] }, "DiscoveryOnPremConnectionConfig": { "allOf": [ { "properties": { "auth": { "$ref": "#/components/schemas/DiscoveryOnPremConnectionAuth" }, "previous_credential": { "$ref": "#/components/schemas/DiscoveryOnPremPreviousCredential" } }, "required": ["auth"], "type": "object" } ] }, "DiscoveryOnPremConnectionState": { "allOf": [ { "properties": { "last_polled_at": { "description": "The time this OnPremConnection was last polled", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "status": { "$ref": "#/components/schemas/DiscoveryOnPremConnectionStatus" } }, "required": ["status"], "type": "object" } ] }, "DiscoveryOnPremConnectionStatus": { "enum": ["pending", "connected", "disconnected"], "type": "string" }, "DiscoveryOnPremCryptoPolicyCompliance": { "allOf": [ { "properties": { "is_compliant": { "type": "boolean" }, "violation_reason": { "nullable": true, "type": "string" } }, "required": ["is_compliant"], "type": "object" } ] }, "DiscoveryOnPremDatabaseAssessmentCryptoAssetMetrics": { "allOf": [ { "properties": { "total_keys": { "type": "integer" } }, "required": ["total_keys"], "type": "object" } ] }, "DiscoveryOnPremDatabaseAssessmentResourceMetrics": { "allOf": [ { "properties": { "quantum_vulnerable_databases": { "type": "integer" }, "total_databases": { "type": "integer" } }, "required": ["total_databases", "quantum_vulnerable_databases"], "type": "object" } ] }, "DiscoveryOnPremDatabaseCryptoAssetMetrics": { "allOf": [ { "properties": { "key_count": { "type": "integer" } }, "required": ["key_count"], "type": "object" } ] }, "DiscoveryOnPremDatabaseKeyMetrics": { "allOf": [ { "properties": { "count_by_source": { "additionalProperties": { "type": "integer" }, "type": "object" }, "count_by_spec": { "additionalProperties": { "type": "integer" }, "type": "object" }, "metrics_by_status": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseKeyMetricsByStatus" } }, "required": [ "count_by_source", "metrics_by_status", "count_by_spec" ], "type": "object" } ] }, "DiscoveryOnPremDatabaseKeyMetricsByStatus": { "allOf": [ { "properties": { "total_active_keys": { "type": "integer" } }, "required": ["total_active_keys"], "type": "object" } ] }, "DiscoveryOnPremDatabaseResourceEncryptionMetrics": { "allOf": [ { "properties": { "fully_encrypted_resources": { "type": "integer" }, "partially_encrypted_resources": { "type": "integer" }, "total_resources": { "type": "integer" }, "unencrypted_resources": { "type": "integer" } }, "required": [ "total_resources", "fully_encrypted_resources", "partially_encrypted_resources", "unencrypted_resources" ], "type": "object" } ] }, "DiscoveryOnPremDatabaseResourceMetrics": { "allOf": [ { "properties": { "encryption_metrics_by_service": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseResourceEncryptionMetrics" }, "type": "object" }, "total_database_servers": { "type": "integer" } }, "required": [ "total_database_servers", "encryption_metrics_by_service" ], "type": "object" } ] }, "DiscoveryOnPremDatabaseResourceViolations": { "allOf": [ { "properties": { "total_violations": { "type": "integer" }, "violation_details_by_variant": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseVariantViolations" }, "type": "object" } }, "required": ["total_violations", "violation_details_by_variant"], "type": "object" } ] }, "DiscoveryOnPremDatabaseRiskAssessment": { "allOf": [ { "properties": { "findings": { "additionalProperties": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" }, "type": "object" }, "type": "object" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["findings", "overall_risk"], "type": "object" } ] }, "DiscoveryOnPremDatabaseScanAssessmentReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseAssessmentCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseAssessmentResourceMetrics" }, "resource_violations": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseResourceViolations" }, "risk_assessment": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseRiskAssessment" }, "security_issues": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" } }, "required": [ "risk_assessment", "security_issues", "resource_violations", "crypto_asset_metrics", "resource_metrics" ], "type": "object" } ] }, "DiscoveryOnPremDatabaseScanSummaryReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseSummaryCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseResourceMetrics" } }, "required": ["crypto_asset_metrics", "resource_metrics"], "type": "object" } ] }, "DiscoveryOnPremDatabaseSummaryCryptoAssetMetrics": { "allOf": [ { "properties": { "key_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseKeyMetrics" }, "metrics_by_database_variant": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseCryptoAssetMetrics" }, "type": "object" }, "total_keys": { "type": "integer" } }, "required": [ "total_keys", "key_metrics", "metrics_by_database_variant" ], "type": "object" } ] }, "DiscoveryOnPremDatabaseVariant": { "enum": ["oracle", "ms_sql"], "type": "string" }, "DiscoveryOnPremDatabaseVariantViolations": { "allOf": [ { "properties": { "risk_level": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" } }, "required": ["risk_level", "violations"], "type": "object" } ] }, "DiscoveryOnPremDetails": { "allOf": [ { "properties": { "hostname": { "type": "string" }, "resource_summary": { "$ref": "#/components/schemas/DiscoveryResourceSummary" } }, "required": ["hostname", "resource_summary"], "type": "object" } ] }, "DiscoveryOnPremDiscoveryData": { "allOf": [ { "properties": { "total_certificates": { "type": "integer" }, "total_crypto_assets": { "type": "integer" }, "total_databases": { "type": "integer" }, "total_filesystem_agents": { "type": "integer" }, "total_keys": { "type": "integer" }, "total_repositories": { "type": "integer" } }, "required": [ "total_databases", "total_repositories", "total_keys", "total_certificates", "total_crypto_assets", "total_filesystem_agents" ], "type": "object" } ] }, "DiscoveryOnPremEncryptionAlgorithm": { "enum": [ "aes", "dsa", "ecdh", "ecmqv", "ed_dsa", "fpe", "hmac_sha", "rc2", "rc4", "rsa", "rsa_oaep", "sike", "des", "des3", "aes128", "aes192", "aes256", "cha_cha20_poly1305", "x_cha_cha20_poly1305", "camellia128", "camellia192", "camellia256", "aria128", "aria192", "aria256", "twofish128", "twofish192", "twofish256", "blowfish128", "blowfish256", "sm4_128", "des56", "tdes2_key112", "tdes3_key168", "des_x", "rc2_40", "rc2_64", "rc2_128", "rc4_40", "rc4_128", "rc4_256", "hmac_sha1", "hmac_sha224", "hmac_sha256", "hmac_sha384", "hmac_sha512", "rsa512", "rsa1024", "rsa2048", "rsa3072", "rsa4096", "ecdsa_p256", "ecdsa_p384", "ecdsa_p521", "ecdsa_secp256k1", "ecdsa_brainpool_p256r1", "ecdsa_brainpool_p384r1", "ecdsa_brainpool_p512r1", "ecdh_p256", "ecdh_p384", "ecdh_p521", "ecdh_secp256k1", "ecdh_brainpool_p256r1", "ecdh_brainpool_p384r1", "ecdh_brainpool_p512r1", "ecmqv_p256", "ecmqv_p384", "ecmqv_p521", "ed25519", "ed448", "x25519", "x448", "ec_generic_p256", "ec_generic_p384", "ec_generic_p521", "ec_generic_secp256k1", "ec_generic_brainpool_p256r1", "ec_generic_brainpool_p384r1", "ec_generic_brainpool_p512r1", "ec_generic_curve25519", "ec_generic_curve448", "dsa1024", "dsa2048", "dsa3072", "sm2_sign", "sm2_kem", "aead_aes256_cbc_hmac_sha256", "ml_kem512", "ml_kem768", "ml_kem1024", "ml_dsa44", "ml_dsa65", "ml_dsa87", "falcon512", "falcon1024", "sphincs_plus_shake128s", "sphincs_plus_shake128f", "sphincs_plus_shake192s", "sphincs_plus_shake192f", "sphincs_plus_shake256s", "sphincs_plus_shake256f", "sike_p434", "sike_p503", "sike_p610", "sike_p751", "hidden", "unknown" ], "type": "string" }, "DiscoveryOnPremFsAgentAnalysis": { "allOf": [ { "properties": { "asset_count_by_type": { "additionalProperties": { "type": "integer" }, "type": "object" }, "certificate_statuses_count": { "additionalProperties": { "type": "integer" }, "type": "object" }, "violations_count": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "type": "object" } }, "required": [ "asset_count_by_type", "violations_count", "certificate_statuses_count" ], "type": "object" } ] }, "DiscoveryOnPremFsAgentInfo": { "allOf": [ { "properties": { "first_seen_at_unix_millis": { "type": "integer" }, "last_seen_at_unix_millis": { "type": "integer" } }, "required": [ "first_seen_at_unix_millis", "last_seen_at_unix_millis" ], "type": "object" } ] }, "DiscoveryOnPremFsAnalysis": { "allOf": [ { "properties": { "agent_analysis": { "$ref": "#/components/schemas/DiscoveryOnPremFsAgentAnalysis" }, "certificate_analysis": { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateAnalysis" }, "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryOnPremCryptoPolicyCompliance" }, "key_spec": { "$ref": "#/components/schemas/DiscoveryOnPremEncryptionAlgorithm" }, "os_analysis": { "$ref": "#/components/schemas/DiscoveryOnPremFsOsAnalysis" }, "violations": { "items": { "$ref": "#/components/schemas/DiscoveryOnPremFsViolation" }, "type": "array", "uniqueItems": true } }, "required": ["violations"], "type": "object" } ] }, "DiscoveryOnPremFsAssessmentCryptoAssetMetrics": { "allOf": [ { "properties": { "asset_metrics_by_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsViolationMetrics" }, "type": "object" }, "certificate_metrics_by_violation": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateViolationMetrics" }, "type": "object" }, "total_assets": { "type": "integer" }, "total_quantum_violations": { "type": "integer" }, "total_violations": { "type": "integer" } }, "required": [ "total_assets", "total_violations", "total_quantum_violations", "asset_metrics_by_type", "certificate_metrics_by_violation" ], "type": "object" } ] }, "DiscoveryOnPremFsAssessmentResourceMetrics": { "allOf": [ { "properties": { "resource_metrics_by_operating_system": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsOperatingSystemMetrics" }, "type": "object" } }, "required": ["resource_metrics_by_operating_system"], "type": "object" } ] }, "DiscoveryOnPremFsAssetType": { "enum": ["key", "certificate", "unspecified"], "type": "string" }, "DiscoveryOnPremFsCertificateAnalysis": { "allOf": [ { "properties": { "certificate_issuer": { "$ref": "#/components/schemas/DiscoveryCertificateIssuer" }, "certificate_status": { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateStatus" }, "certificate_subject": { "$ref": "#/components/schemas/DiscoveryCertificateSubject" } }, "required": [ "certificate_status", "certificate_issuer", "certificate_subject" ], "type": "object" } ] }, "DiscoveryOnPremFsCertificateMetrics": { "allOf": [ { "properties": { "certificate_count": { "type": "integer" } }, "required": ["certificate_count"], "type": "object" } ] }, "DiscoveryOnPremFsCertificateStatus": { "enum": [ "issued", "inactive", "expired", "failed", "revoked", "pending_validation" ], "type": "string" }, "DiscoveryOnPremFsCertificateViolationMetrics": { "allOf": [ { "properties": { "by_issuer": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateViolationMetricsBucket" }, "type": "object" }, "risk_level": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["risk_level", "by_issuer"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateViolationMetricsBucket" } ] }, "DiscoveryOnPremFsCertificateViolationMetricsBucket": { "allOf": [ { "properties": { "violation_count": { "type": "integer" } }, "required": ["violation_count"], "type": "object" } ] }, "DiscoveryOnPremFsCryptoAssetMetrics": { "allOf": [ { "properties": { "asset_count": { "type": "integer" } }, "required": ["asset_count"], "type": "object" } ] }, "DiscoveryOnPremFsObject": { "allOf": [ { "properties": { "agent_info": { "$ref": "#/components/schemas/DiscoveryOnPremFsAgentInfo" }, "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremFsAnalysis" }, "host_info": { "$ref": "#/components/schemas/DiscoveryHostInfo" }, "object": { "$ref": "#/components/schemas/DiscoveryFilesystemScannedObject" } }, "required": ["host_info", "agent_info", "object", "analysis"], "type": "object" } ] }, "DiscoveryOnPremFsOperatingSystemMetrics": { "allOf": [ { "properties": { "violation_count": { "type": "integer" }, "violation_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsViolationMetrics" }, "type": "object" } }, "required": ["violation_count", "violation_metrics"], "type": "object" } ] }, "DiscoveryOnPremFsOsAnalysis": { "allOf": [ { "properties": { "agent_count": { "type": "integer" }, "asset_count_by_type": { "additionalProperties": { "type": "integer" }, "type": "object" }, "certificate_statuses_count": { "additionalProperties": { "type": "integer" }, "type": "object" }, "violations_count": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "type": "object" } }, "required": [ "agent_count", "asset_count_by_type", "violations_count", "certificate_statuses_count" ], "type": "object" } ] }, "DiscoveryOnPremFsScanAssessmentReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremFsAssessmentCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremFsAssessmentResourceMetrics" }, "risk_score": { "$ref": "#/components/schemas/DiscoveryOnPremFsSummaryRiskScore" } }, "required": [ "risk_score", "crypto_asset_metrics", "resource_metrics" ], "type": "object" } ] }, "DiscoveryOnPremFsScanSummaryReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremFsSummaryCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremFsSummaryResourceMetrics" } }, "required": ["resource_metrics", "crypto_asset_metrics"], "type": "object" } ] }, "DiscoveryOnPremFsSummaryCryptoAssetMetrics": { "allOf": [ { "properties": { "asset_metrics_by_key_spec": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCryptoAssetMetrics" }, "type": "object" }, "type": "object" }, "asset_metrics_by_operating_system": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCryptoAssetMetrics" }, "type": "object" }, "type": "object" }, "asset_metrics_by_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCryptoAssetMetrics" }, "type": "object" }, "certificate_metrics_by_status": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsCertificateMetrics" }, "type": "object" }, "total_assets": { "type": "integer" } }, "required": [ "total_assets", "asset_metrics_by_type", "asset_metrics_by_operating_system", "asset_metrics_by_key_spec", "certificate_metrics_by_status" ], "type": "object" } ] }, "DiscoveryOnPremFsSummaryResourceMetrics": { "allOf": [ { "properties": { "total_operating_systems": { "type": "integer" } }, "required": ["total_operating_systems"], "type": "object" } ] }, "DiscoveryOnPremFsSummaryRiskScore": { "allOf": [ { "properties": { "findings": { "additionalProperties": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsSummaryRiskScoreMetrics" }, "type": "object" }, "type": "object" }, "type": "object" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["findings", "overall_risk"], "type": "object" } ] }, "DiscoveryOnPremFsSummaryRiskScoreMetrics": { "allOf": [ { "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryOnPremFsViolation": { "enum": [ "expired", "expiring_soon", "non_compliant_algorithm", "non_compliant_signature", "key_not_rotated_in_compliance_period", "secret_file_too_readable", "anyone_can_write", "expiry_exceeds_threshold", "overly_permissive_certificate", "quantum_vulnerable" ], "type": "string" }, "DiscoveryOnPremFsViolationMetrics": { "allOf": [ { "properties": { "violation_by_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremFsViolationMetricsBucket" }, "type": "object" } }, "required": ["violation_by_type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremFsViolationMetricsBucket" } ] }, "DiscoveryOnPremFsViolationMetricsBucket": { "allOf": [ { "properties": { "risk_level": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violation_count": { "type": "integer" } }, "required": ["violation_count", "risk_level"], "type": "object" } ] }, "DiscoveryOnPremKey": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremKeyAnalysis" }, "created_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "encryption_algorithm": { "$ref": "#/components/schemas/DiscoveryOnPremEncryptionAlgorithm" }, "expires_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "key_category": { "$ref": "#/components/schemas/DiscoveryOnPremKeyCategory" }, "key_rotation_status": { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationStatus" }, "key_source": { "$ref": "#/components/schemas/DiscoveryOnPremKeySource" }, "name": { "nullable": true, "type": "string" }, "next_rotation_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "source_scan_inventory_object": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectReference" }, "status": { "$ref": "#/components/schemas/DiscoveryOnPremKeyStatus" }, "version": { "nullable": true, "type": "string" } }, "required": [ "status", "key_source", "key_category", "encryption_algorithm", "key_rotation_status", "analysis" ], "type": "object" } ] }, "DiscoveryOnPremKeyAnalysis": { "allOf": [ { "properties": { "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryOnPremCryptoPolicyCompliance" }, "key_expiration_compliance": { "$ref": "#/components/schemas/DiscoveryOnPremKeyExpirationCompliance" }, "key_rotation_compliance": { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationCompliance" }, "usage_details": { "$ref": "#/components/schemas/DiscoveryKeyUsageDetails" } }, "required": ["usage_details", "key_rotation_compliance"], "type": "object" } ] }, "DiscoveryOnPremKeyCategory": { "enum": ["master_key", "data_encryption_key", "asymmetric_key"], "type": "string" }, "DiscoveryOnPremKeyExpirationCompliance": { "allOf": [ { "properties": { "key_expiry_greater_than_compliance_period": { "type": "boolean" } }, "required": ["key_expiry_greater_than_compliance_period"], "type": "object" } ] }, "DiscoveryOnPremKeyRotationCompliance": { "enum": [ "compliant", "not_rotated_in_compliance_period", "rotation_status_not_known" ], "type": "string" }, "DiscoveryOnPremKeyRotationStatus": { "discriminator": { "mapping": { "not_rotated": "DiscoveryOnPremKeyRotationStatusVariantNotRotated", "rotated": "DiscoveryOnPremKeyRotationStatusVariantRotated", "unknown": "DiscoveryOnPremKeyRotationStatusVariantUnknown" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationStatusVariantUnknown" }, { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationStatusVariantRotated" }, { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationStatusVariantNotRotated" } ] }, "DiscoveryOnPremKeyRotationStatusRotated": { "allOf": [ { "properties": { "last_rotated_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" } }, "required": ["last_rotated_at"], "type": "object" } ] }, "DiscoveryOnPremKeyRotationStatusVariantNotRotated": { "allOf": [ { "properties": { "$type": { "enum": ["not_rotated"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryOnPremKeyRotationStatusVariantRotated": { "allOf": [ { "properties": { "$type": { "enum": ["rotated"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremKeyRotationStatusRotated" } ] }, "DiscoveryOnPremKeyRotationStatusVariantUnknown": { "allOf": [ { "properties": { "$type": { "enum": ["unknown"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryOnPremKeySource": { "enum": [ "hsm", "fortanix", "oracle_key_vault", "azure_kv", "file_system_key_store", "native", "other" ], "type": "string" }, "DiscoveryOnPremKeyStatus": { "enum": ["valid", "expired"], "type": "string" }, "DiscoveryOnPremMsSqlDatabase": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremMsSqlDatabaseAnalysis" }, "database_name": { "type": "string" }, "encrypted": { "$ref": "#/components/schemas/DiscoveryOnPremMsSqlDatabaseEncryptionStatus" }, "encryption_details": { "items": { "$ref": "#/components/schemas/DiscoveryOnPremMsSqlDatabaseEncryption" }, "type": "array" } }, "required": [ "database_name", "encryption_details", "encrypted", "analysis" ], "type": "object" } ] }, "DiscoveryOnPremMsSqlDatabaseAnalysis": { "allOf": [ { "properties": { "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryOnPremMsSqlDatabaseEncryption": { "allOf": [ { "properties": { "encryption_key_id": { "type": "string" }, "encryption_key_use": { "$ref": "#/components/schemas/DiscoveryOnPremMsSqlDatabaseEncryptionKeyUse" } }, "required": ["encryption_key_id", "encryption_key_use"], "type": "object" } ] }, "DiscoveryOnPremMsSqlDatabaseEncryptionKeyUse": { "enum": ["tde", "column_level"], "type": "string" }, "DiscoveryOnPremMsSqlDatabaseEncryptionStatus": { "enum": [ "no_encryption_key", "unencrypted", "encryption_in_progress", "encrypted", "key_change_in_progress", "decryption_in_progress", "protection_change_in_progress" ], "type": "string" }, "DiscoveryOnPremObject": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetails" }, "resource_host_details": { "$ref": "#/components/schemas/DiscoveryOnPremResourceHostDetails" }, "resource_id": { "type": "string" } }, "required": ["resource_id", "resource_host_details", "details"], "type": "object" } ] }, "DiscoveryOnPremObjectDetails": { "discriminator": { "mapping": { "filesystem": "DiscoveryOnPremObjectDetailsVariantFilesystem", "on_prem_key": "DiscoveryOnPremObjectDetailsVariantOnPremKey", "on_prem_ms_sql_database": "DiscoveryOnPremObjectDetailsVariantOnPremMsSqlDatabase", "on_prem_oracle_database": "DiscoveryOnPremObjectDetailsVariantOnPremOracleDatabase", "on_prem_source_code_component": "DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeComponent", "on_prem_source_code_repo": "DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeRepo" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantOnPremKey" }, { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantOnPremMsSqlDatabase" }, { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantOnPremOracleDatabase" }, { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeRepo" }, { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeComponent" }, { "$ref": "#/components/schemas/DiscoveryOnPremObjectDetailsVariantFilesystem" } ] }, "DiscoveryOnPremObjectDetailsVariantFilesystem": { "allOf": [ { "properties": { "$type": { "enum": ["filesystem"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremFsObject" } ] }, "DiscoveryOnPremObjectDetailsVariantOnPremKey": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_key"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremKey" } ] }, "DiscoveryOnPremObjectDetailsVariantOnPremMsSqlDatabase": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_ms_sql_database"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremMsSqlDatabase" } ] }, "DiscoveryOnPremObjectDetailsVariantOnPremOracleDatabase": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_oracle_database"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabase" } ] }, "DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeComponent": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_source_code_component"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponent" } ] }, "DiscoveryOnPremObjectDetailsVariantOnPremSourceCodeRepo": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem_source_code_repo"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeRepo" } ] }, "DiscoveryOnPremOracleDatabase": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabaseAnalysis" }, "database_name": { "type": "string" }, "encryption_details": { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabaseEncryption" } }, "required": ["database_name", "analysis"], "type": "object" } ] }, "DiscoveryOnPremOracleDatabaseAnalysis": { "allOf": [ { "properties": { "encrypted_with_noncompliant_key": { "type": "boolean" }, "encrypted_with_quantum_vulnerable_key": { "nullable": true, "type": "boolean" } }, "required": ["encrypted_with_noncompliant_key"], "type": "object" } ] }, "DiscoveryOnPremOracleDatabaseEncryption": { "allOf": [ { "properties": { "encryption_key_details": { "items": { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabaseEncryptionKeyDetails" }, "type": "array" }, "wallet_location": { "nullable": true, "type": "string" }, "wallet_name": { "type": "string" }, "wallet_status": { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabaseEncryptionWalletStatus" } }, "required": [ "wallet_name", "wallet_status", "encryption_key_details" ], "type": "object" } ] }, "DiscoveryOnPremOracleDatabaseEncryptionKeyDetails": { "allOf": [ { "properties": { "encryption_key_id": { "type": "string" }, "encryption_key_use": { "$ref": "#/components/schemas/DiscoveryOnPremOracleDatabaseEncryptionKeyUse" } }, "required": ["encryption_key_id", "encryption_key_use"], "type": "object" } ] }, "DiscoveryOnPremOracleDatabaseEncryptionKeyUse": { "enum": ["tde", "column_level"], "type": "string" }, "DiscoveryOnPremOracleDatabaseEncryptionWalletStatus": { "enum": [ "valid", "expired", "unavailable", "closed", "open", "open_no_master_key", "open_unknown_master_key_status", "undefined" ], "type": "string" }, "DiscoveryOnPremPreviousCredential": { "allOf": [ { "properties": { "credential": { "$ref": "#/components/schemas/DiscoveryOnPremConnectionAuth" }, "valid_until": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" } }, "required": ["credential", "valid_until"], "type": "object" } ] }, "DiscoveryOnPremResourceHostDetails": { "allOf": [ { "properties": { "uri": { "type": "string" } }, "required": ["uri"], "type": "object" } ] }, "DiscoveryOnPremScanSummaryReport": { "allOf": [ { "properties": { "onprem_discovery": { "$ref": "#/components/schemas/DiscoveryOnPremDiscoveryData" } }, "required": ["onprem_discovery"], "type": "object" } ] }, "DiscoveryOnPremService": { "enum": [ "on_prem_key", "on_prem_ms_sql_database", "on_prem_oracle_database", "on_prem_source_code_repo", "on_prem_source_code_component", "filesystem" ], "type": "string" }, "DiscoveryOnPremSourceCodeAssessmentCryptoAssetMetrics": { "allOf": [ { "properties": { "total_assets": { "type": "integer" } }, "required": ["total_assets"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponent": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponentAnalysis" }, "details": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponentDetails" }, "repo_url": { "format": "url", "type": "string" }, "revision": { "type": "string" } }, "required": ["repo_url", "revision", "details", "analysis"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponentAnalysis": { "allOf": [ { "properties": { "crypto_policy_compliance": { "$ref": "#/components/schemas/DiscoveryOnPremCryptoPolicyCompliance" }, "is_quantum_vulnerable": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponentCryptoSpec": { "oneOf": [ { "enum": ["rsa512"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsa512", "type": "string" }, { "enum": ["rsa1024"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsa1024", "type": "string" }, { "enum": ["rsa2048"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsa2048", "type": "string" }, { "enum": ["rsa3072"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsa3072", "type": "string" }, { "enum": ["rsa4096"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsa4096", "type": "string" }, { "enum": ["aes128"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantAes128", "type": "string" }, { "enum": ["aes192"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantAes192", "type": "string" }, { "enum": ["aes256"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantAes256", "type": "string" }, { "enum": ["ecc_nist_p256"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccNistP256", "type": "string" }, { "enum": ["ecc_nist_p384"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccNistP384", "type": "string" }, { "enum": ["ecc_nist_p521"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccNistP521", "type": "string" }, { "enum": ["ecc_ed25519"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccEd25519", "type": "string" }, { "enum": ["ecc_x25519"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccX25519", "type": "string" }, { "enum": ["ecc_secg_p256_k1"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantEccSecgP256K1", "type": "string" }, { "enum": ["hmac224"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantHmac224", "type": "string" }, { "enum": ["hmac256"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantHmac256", "type": "string" }, { "enum": ["hmac384"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantHmac384", "type": "string" }, { "enum": ["hmac512"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantHmac512", "type": "string" }, { "enum": ["sha1"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha1", "type": "string" }, { "enum": ["sha224"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha224", "type": "string" }, { "enum": ["sha256"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha256", "type": "string" }, { "enum": ["sha384"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha384", "type": "string" }, { "enum": ["sha512"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha512", "type": "string" }, { "enum": ["sha3_224"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha3_224", "type": "string" }, { "enum": ["sha3_256"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha3_256", "type": "string" }, { "enum": ["sha3_384"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha3_384", "type": "string" }, { "enum": ["sha3_512"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSha3_512", "type": "string" }, { "enum": ["rsa_oaep"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantRsaOaep", "type": "string" }, { "enum": ["des"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantDes", "type": "string" }, { "enum": ["des3"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantDes3", "type": "string" }, { "enum": ["des_x"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantDesX", "type": "string" }, { "enum": ["sm2"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantSm2", "type": "string" }, { "properties": { "other": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponentCryptoSpecOther" } }, "required": ["other"], "title": "DiscoveryOnPremSourceCodeComponentCryptoSpecVariantOther", "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponentCryptoSpecOther": { "allOf": [ { "properties": { "value": { "type": "string" } }, "required": ["value"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponentDetails": { "allOf": [ { "properties": { "asset_type": { "$ref": "#/components/schemas/DiscoveryOnPremCbomComponentType" }, "bom_ref": { "type": "string" }, "key_spec": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponentCryptoSpec" }, "name": { "type": "string" }, "occurrences": { "items": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeComponentOccurrence" }, "type": "array" } }, "required": ["bom_ref", "name", "asset_type", "occurrences"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeComponentOccurrence": { "allOf": [ { "properties": { "additional_context": { "nullable": true, "type": "string" }, "bom_ref": { "nullable": true, "type": "string" }, "line": { "nullable": true, "type": "integer" }, "location": { "type": "string" }, "offset": { "nullable": true, "type": "integer" }, "symbol": { "nullable": true, "type": "string" } }, "required": ["location"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeCryptoAssetMetrics": { "allOf": [ { "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeRepo": { "allOf": [ { "properties": { "analysis": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeRepoAnalysis" }, "branch": { "type": "string" }, "name": { "type": "string" }, "repo_url": { "format": "url", "type": "string" }, "revision": { "type": "string" }, "subfolder": { "nullable": true, "type": "string" } }, "required": ["repo_url", "name", "branch", "revision", "analysis"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeRepoAnalysis": { "allOf": [ { "properties": { "asset_count": { "type": "integer" }, "violations": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" } }, "required": ["asset_count", "violations"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeRepositoryViolations": { "allOf": [ { "properties": { "risk_level": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" } }, "required": ["risk_level", "violations"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeResourceMetrics": { "allOf": [ { "properties": { "total_repositories": { "type": "integer" } }, "required": ["total_repositories"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeResourceViolations": { "allOf": [ { "properties": { "repository_metrics_by_violation": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeViolationRepositoryMetrics" }, "type": "object" }, "total_violations": { "type": "integer" }, "violation_details_by_repository": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeRepositoryViolations" }, "description": "Map from Repository URL to repository violation details", "type": "object" } }, "required": [ "total_violations", "violation_details_by_repository", "repository_metrics_by_violation" ], "type": "object" } ] }, "DiscoveryOnPremSourceCodeRiskAssessment": { "allOf": [ { "properties": { "findings": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" }, "type": "object" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["findings", "overall_risk"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeScanAssessmentReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeAssessmentCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeResourceMetrics" }, "resource_violations": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeResourceViolations" }, "risk_assessment": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeRiskAssessment" }, "security_issues": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" } }, "required": [ "risk_assessment", "security_issues", "resource_violations", "resource_metrics", "crypto_asset_metrics" ], "type": "object" } ] }, "DiscoveryOnPremSourceCodeScanSummaryReport": { "allOf": [ { "properties": { "crypto_asset_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeSummaryCryptoAssetMetrics" }, "resource_metrics": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeResourceMetrics" } }, "required": ["resource_metrics", "crypto_asset_metrics"], "type": "object" } ] }, "DiscoveryOnPremSourceCodeSummaryCryptoAssetMetrics": { "allOf": [ { "properties": { "asset_metrics_by_repository": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeCryptoAssetMetrics" }, "description": "Map from Repository URL to count of crypto assets in the repository", "type": "object" }, "asset_metrics_by_type": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeCryptoAssetMetrics" }, "type": "object" }, "total_assets": { "type": "integer" } }, "required": [ "total_assets", "asset_metrics_by_repository", "asset_metrics_by_type" ], "type": "object" } ] }, "DiscoveryOnPremSourceCodeViolationRepositoryMetrics": { "allOf": [ { "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryOnPremViolation": { "enum": [ "unencrypted_databases", "partially_encrypted_databases", "active_keys_not_rotated", "non_compliant_keys", "key_expiry_exceeds_threshold", "non_hsm_managed_keys", "quantum_vulnerable_keys", "non_compliant_assets" ], "type": "string" }, "DiscoveryOpaqueOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryOpenSshPrivateKeyMetadata": { "allOf": [ { "properties": { "comment": { "type": "string" }, "private_key": { "$ref": "#/components/schemas/DiscoveryPrivateKeyMetadata" }, "public_key": { "$ref": "#/components/schemas/DiscoveryPublicKeyMetadata" } }, "required": ["comment", "public_key", "private_key"], "type": "object" } ] }, "DiscoveryOpenSshPublicKeyMetadata": { "allOf": [ { "properties": { "comment": { "type": "string" }, "public_key": { "$ref": "#/components/schemas/DiscoveryPublicKeyMetadata" } }, "required": ["comment", "public_key"], "type": "object" } ] }, "DiscoveryOverlyPermissiveViolations": { "allOf": [ { "properties": { "management_violations": { "items": { "$ref": "#/components/schemas/DiscoveryKeyPolicyId" }, "type": "array" }, "usage_violations": { "items": { "$ref": "#/components/schemas/DiscoveryKeyPolicyId" }, "type": "array" } }, "required": ["usage_violations", "management_violations"], "type": "object" } ] }, "DiscoveryOwnerAndFlags": { "allOf": [ { "description": "Properties for \"User\"s and \"Group\"s of a file", "properties": { "flags": { "description": "What the owner can do with the file", "items": { "$ref": "#/components/schemas/DiscoveryPermissionFlag" }, "type": "array" }, "id": { "description": "User or Group id -- String to allow representing both POSIX & Windows IDs", "type": "string" }, "name": { "description": "User or Group name", "type": "string" } }, "required": ["id", "name", "flags"], "type": "object" } ] }, "DiscoveryParametersMetadata": { "oneOf": [ { "properties": { "elliptic_curve": { "$ref": "#/components/schemas/DiscoveryEllipticCurveParamsMetadata" } }, "required": ["elliptic_curve"], "title": "DiscoveryParametersMetadataVariantEllipticCurve", "type": "object" }, { "properties": { "diffie_hellman": { "$ref": "#/components/schemas/DiscoveryDiffieHellmanParamsMetadata" } }, "required": ["diffie_hellman"], "title": "DiscoveryParametersMetadataVariantDiffieHellman", "type": "object" } ] }, "DiscoveryPermissionFlag": { "enum": ["Read", "Write", "Execute"], "type": "string" }, "DiscoveryPermissions": { "allOf": [ { "properties": { "everyone": { "description": "“Other” users on POSIX; on Windows, “Everyone” ACL entry", "items": { "$ref": "#/components/schemas/DiscoveryPermissionFlag" }, "type": "array" }, "group": { "$ref": "#/components/schemas/DiscoveryOwnerAndFlags" }, "user": { "$ref": "#/components/schemas/DiscoveryOwnerAndFlags" } }, "required": ["user", "everyone"], "type": "object" } ] }, "DiscoveryPgpMessageMetadata": { "enum": [ "Literal", "Compressed", "Signed", "SignedOnePass", "Encrypted" ], "type": "string" }, "DiscoveryPgpMetadata": { "oneOf": [ { "properties": { "PrivateKey": { "$ref": "#/components/schemas/DiscoveryPgpPrivateKeyMetadata" } }, "required": ["PrivateKey"], "title": "DiscoveryPgpMetadataVariantPrivateKey", "type": "object" }, { "properties": { "PublicKey": { "$ref": "#/components/schemas/DiscoveryPgpPublicKeyMetadata" } }, "required": ["PublicKey"], "title": "DiscoveryPgpMetadataVariantPublicKey", "type": "object" }, { "properties": { "Message": { "$ref": "#/components/schemas/DiscoveryPgpMessageMetadata" } }, "required": ["Message"], "title": "DiscoveryPgpMetadataVariantMessage", "type": "object" }, { "properties": { "Signature": { "$ref": "#/components/schemas/DiscoveryPgpSignatureMetadata" } }, "required": ["Signature"], "title": "DiscoveryPgpMetadataVariantSignature", "type": "object" } ] }, "DiscoveryPgpPrivateKeyMetadata": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryPgpPublicKeyMetadata": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryPgpSignatureMetadata": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoveryPkcs12MacMetadata": { "allOf": [ { "properties": { "algorith": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "digest": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" } }, "required": ["algorith", "digest"], "type": "object" } ] }, "DiscoveryPkcs12Metadata": { "allOf": [ { "properties": { "encrypted": { "type": "boolean" }, "mac_data": { "$ref": "#/components/schemas/DiscoveryPkcs12MacMetadata" } }, "required": ["encrypted"], "type": "object" } ] }, "DiscoveryPkcs7Attribute": { "allOf": [ { "properties": { "attribute_type": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": ["attribute_type", "values"], "type": "object" } ] }, "DiscoveryPkcs7DataMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7DataWithAttributesMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7DigestedDataMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7EncryptedDataMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7EncryptedPrivateKeyInfoMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7EnvelopedDataMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7Metadata": { "oneOf": [ { "properties": { "data": { "$ref": "#/components/schemas/DiscoveryPkcs7DataMetadata" } }, "required": ["data"], "title": "DiscoveryPkcs7MetadataVariantData", "type": "object" }, { "properties": { "signed_data": { "$ref": "#/components/schemas/DiscoveryPkcs7SignedDataMetadata" } }, "required": ["signed_data"], "title": "DiscoveryPkcs7MetadataVariantSignedData", "type": "object" }, { "properties": { "enveloped_data": { "$ref": "#/components/schemas/DiscoveryPkcs7EnvelopedDataMetadata" } }, "required": ["enveloped_data"], "title": "DiscoveryPkcs7MetadataVariantEnvelopedData", "type": "object" }, { "properties": { "signed_and_enveloped_data": { "$ref": "#/components/schemas/DiscoveryPkcs7SignedAndEnvelopedDataMetadata" } }, "required": ["signed_and_enveloped_data"], "title": "DiscoveryPkcs7MetadataVariantSignedAndEnvelopedData", "type": "object" }, { "properties": { "digested_data": { "$ref": "#/components/schemas/DiscoveryPkcs7DigestedDataMetadata" } }, "required": ["digested_data"], "title": "DiscoveryPkcs7MetadataVariantDigestedData", "type": "object" }, { "properties": { "encrypted_data": { "$ref": "#/components/schemas/DiscoveryPkcs7EncryptedDataMetadata" } }, "required": ["encrypted_data"], "title": "DiscoveryPkcs7MetadataVariantEncryptedData", "type": "object" }, { "properties": { "data_with_attributes": { "$ref": "#/components/schemas/DiscoveryPkcs7DataWithAttributesMetadata" } }, "required": ["data_with_attributes"], "title": "DiscoveryPkcs7MetadataVariantDataWithAttributes", "type": "object" }, { "properties": { "encrypted_private_key_info": { "$ref": "#/components/schemas/DiscoveryPkcs7EncryptedPrivateKeyInfoMetadata" } }, "required": ["encrypted_private_key_info"], "title": "DiscoveryPkcs7MetadataVariantEncryptedPrivateKeyInfo", "type": "object" } ] }, "DiscoveryPkcs7SignedAndEnvelopedDataMetadata": { "allOf": [ { "properties": { "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": ["version"], "type": "object" } ] }, "DiscoveryPkcs7SignedDataMetadata": { "allOf": [ { "properties": { "certificates": { "items": { "$ref": "#/components/schemas/DiscoveryCertificateMetadata" }, "nullable": true, "type": "array" }, "crls": { "items": { "$ref": "#/components/schemas/DiscoveryCertificateRevocationList" }, "nullable": true, "type": "array" }, "digest_algorithms": { "items": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "type": "array" }, "encapsulated_content_type": { "type": "string" }, "signer_info": { "items": { "$ref": "#/components/schemas/DiscoveryPkcs7SignerInfoMetadata" }, "type": "array" }, "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "version", "encapsulated_content_type", "digest_algorithms", "signer_info" ], "type": "object" } ] }, "DiscoveryPkcs7SignerIdentifieroMetadata": { "oneOf": [ { "properties": { "issuer_and_serial_number": { "$ref": "#/components/schemas/DiscoveryPkcs7SignerIdentifieroMetadataIssuerAndSerialNumber" } }, "required": ["issuer_and_serial_number"], "title": "DiscoveryPkcs7SignerIdentifieroMetadataVariantIssuerAndSerialNumber", "type": "object" }, { "properties": { "subject_key_identifier": { "$ref": "#/components/schemas/DiscoveryPkcs7SignerIdentifieroMetadataSubjectKeyIdentifier" } }, "required": ["subject_key_identifier"], "title": "DiscoveryPkcs7SignerIdentifieroMetadataVariantSubjectKeyIdentifier", "type": "object" } ] }, "DiscoveryPkcs7SignerIdentifieroMetadataIssuerAndSerialNumber": { "allOf": [ { "properties": { "name": { "items": { "type": "string" }, "type": "array" }, "serial_number": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" } }, "required": ["name", "serial_number"], "type": "object" } ] }, "DiscoveryPkcs7SignerIdentifieroMetadataSubjectKeyIdentifier": { "allOf": [ { "properties": { "id": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" } }, "required": ["id"], "type": "object" } ] }, "DiscoveryPkcs7SignerInfoMetadata": { "allOf": [ { "properties": { "digest_alg": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "sid": { "$ref": "#/components/schemas/DiscoveryPkcs7SignerIdentifieroMetadata" }, "signature": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "type": "array" }, "signature_alg": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "signed_attributes": { "items": { "$ref": "#/components/schemas/DiscoveryPkcs7Attribute" }, "nullable": true, "type": "array" }, "unsigned_attributes": { "items": { "$ref": "#/components/schemas/DiscoveryPkcs7Attribute" }, "nullable": true, "type": "array" }, "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "version", "digest_alg", "sid", "signature_alg", "signature" ], "type": "object" } ] }, "DiscoveryPolicy": { "allOf": [ { "description": "Policy in Predjama.", "properties": { "created_at": { "description": "The time this Policy object was created", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "details": { "$ref": "#/components/schemas/DiscoveryPolicyDetails" }, "last_updated_at": { "description": "The time at which this Policy object was last updated", "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "name": { "description": "Name of the Policy", "maxLength": 4096, "pattern": "^[^\\n]*[^\\s\\n][^\\n]*$", "type": "string" }, "policy_id": { "description": "An internally generated Uuid for the Policy type", "format": "uuid", "type": "string" }, "source": { "$ref": "#/components/schemas/DiscoveryPolicySource" } }, "required": [ "created_at", "details", "name", "policy_id", "source" ], "type": "object" } ] }, "DiscoveryPolicyDetails": { "discriminator": { "mapping": { "crypto_policy": "DiscoveryPolicyDetailsVariantCryptoPolicy" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryPolicyDetailsVariantCryptoPolicy" } ] }, "DiscoveryPolicyDetailsVariantCryptoPolicy": { "allOf": [ { "properties": { "$type": { "enum": ["crypto_policy"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryCryptographicPolicy" } ] }, "DiscoveryPolicySource": { "discriminator": { "mapping": { "dsm": "DiscoveryPolicySourceVariantDsm", "system_defined": "DiscoveryPolicySourceVariantSystemDefined", "user_defined": "DiscoveryPolicySourceVariantUserDefined" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryPolicySourceVariantSystemDefined" }, { "$ref": "#/components/schemas/DiscoveryPolicySourceVariantDsm" }, { "$ref": "#/components/schemas/DiscoveryPolicySourceVariantUserDefined" } ] }, "DiscoveryPolicySourceVariantDsm": { "allOf": [ { "properties": { "$type": { "enum": ["dsm"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryPolicySourceVariantSystemDefined": { "allOf": [ { "properties": { "$type": { "enum": ["system_defined"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryPolicySourceVariantUserDefined": { "allOf": [ { "properties": { "$type": { "enum": ["user_defined"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "properties": {}, "type": "object" } ] }, "DiscoveryPqcCumulativeReport": { "allOf": [ { "properties": { "connection_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportViolationMetricsForConnection" }, "type": "object" }, "connection_summary": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "type": "object" } }, "required": ["connection_summary", "connection_metrics"], "type": "object" } ] }, "DiscoveryPqcReport": { "allOf": [ { "description": "Pqc Central Report in Predjama.", "properties": { "connection_id": { "format": "uuid", "type": "string" }, "connection_metrics": { "$ref": "#/components/schemas/DiscoveryPqcReportViolationMetricsForConnection" }, "connection_name": { "type": "string" }, "connection_type": { "$ref": "#/components/schemas/DiscoveryPqcReportConnectionType" } }, "required": [ "connection_id", "connection_metrics", "connection_name", "connection_type" ], "type": "object" } ] }, "DiscoveryPqcReportCertificatesViolationMetrics": { "allOf": [ { "properties": { "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "service_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportCertificatesViolationMetricsForService" }, "type": "object" } }, "required": ["overall_status", "service_metrics"], "type": "object" } ] }, "DiscoveryPqcReportCertificatesViolationMetricsForService": { "allOf": [ { "properties": { "certificate_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "type": "object" }, "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "services_metrics": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "vulnerable_regions": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "overall_status", "services_metrics", "vulnerable_regions", "certificate_metrics" ], "type": "object" } ] }, "DiscoveryPqcReportConnectionParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryPqcReportConnectionType": { "enum": ["cloud", "on_prem", "external"], "type": "string" }, "DiscoveryPqcReportConnections": { "allOf": [ { "properties": { "connection_id": { "format": "uuid", "type": "string" }, "connection_name": { "type": "string" }, "connection_type": { "$ref": "#/components/schemas/DiscoveryPqcReportConnectionType" }, "service_type": { "$ref": "#/components/schemas/DiscoveryPqcReportServiceType" }, "vulnerability_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" } }, "required": [ "connection_id", "connection_name", "connection_type", "service_type", "vulnerability_status" ], "type": "object" } ] }, "DiscoveryPqcReportConnectionsResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryPqcReportConnections" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryPqcReportKeysViolationMetrics": { "allOf": [ { "properties": { "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "service_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportKeysViolationMetricsForService" }, "type": "object" } }, "required": ["overall_status", "service_metrics"], "type": "object" } ] }, "DiscoveryPqcReportKeysViolationMetricsForService": { "allOf": [ { "properties": { "key_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "type": "object" }, "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "services_summary": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "vulnerable_regions": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "overall_status", "services_summary", "vulnerable_regions", "key_metrics" ], "type": "object" } ] }, "DiscoveryPqcReportMetrics": { "allOf": [ { "properties": { "pqc_vulnerable_count": { "type": "integer" }, "total_count": { "type": "integer" } }, "required": ["total_count", "pqc_vulnerable_count"], "type": "object" } ] }, "DiscoveryPqcReportResourceMetrics": { "allOf": [ { "properties": { "pqc_vulnerable_count": { "type": "integer" }, "total_count": { "type": "integer" }, "unencrypted_count": { "type": "integer" } }, "required": [ "total_count", "unencrypted_count", "pqc_vulnerable_count" ], "type": "object" } ] }, "DiscoveryPqcReportResourceViolationMetricsForService": { "allOf": [ { "properties": { "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "resource_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportResourceMetrics" }, "type": "object" }, "services_summary": { "$ref": "#/components/schemas/DiscoveryPqcReportMetrics" }, "vulnerable_regions": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "overall_status", "services_summary", "vulnerable_regions", "resource_metrics" ], "type": "object" } ] }, "DiscoveryPqcReportResourcesViolationMetrics": { "allOf": [ { "properties": { "overall_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" }, "service_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryPqcReportResourceViolationMetricsForService" }, "type": "object" } }, "required": ["overall_status", "service_metrics"], "type": "object" } ] }, "DiscoveryPqcReportService": { "allOf": [ { "description": "Pqc Central Report in Predjama.", "properties": { "connection_id": { "format": "uuid", "type": "string" }, "connection_type": { "$ref": "#/components/schemas/DiscoveryPqcReportConnectionType" }, "service_id": { "type": "string" }, "service_name": { "type": "string" }, "service_type": { "$ref": "#/components/schemas/DiscoveryPqcReportServiceType" }, "vulnerability_status": { "$ref": "#/components/schemas/DiscoveryPqcReportVulnerabilityStatus" } }, "required": [ "connection_id", "connection_type", "service_id", "service_name", "service_type", "vulnerability_status" ], "type": "object" } ] }, "DiscoveryPqcReportServiceParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryPqcReportServiceType": { "enum": ["aws", "azure", "databases", "dsm"], "type": "string" }, "DiscoveryPqcReportServicesResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryPqcReportService" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryPqcReportViolationMetricsForConnection": { "allOf": [ { "properties": { "certificates": { "$ref": "#/components/schemas/DiscoveryPqcReportCertificatesViolationMetrics" }, "keys": { "$ref": "#/components/schemas/DiscoveryPqcReportKeysViolationMetrics" }, "resources": { "$ref": "#/components/schemas/DiscoveryPqcReportResourcesViolationMetrics" } }, "required": ["keys", "resources"], "type": "object" } ] }, "DiscoveryPqcReportVulnerabilityStatus": { "enum": ["pqc_vulnerable", "pqc_safe"], "type": "string" }, "DiscoveryPrivateKeyMetadata": { "allOf": [ { "properties": { "algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "encryption": { "$ref": "#/components/schemas/DiscoveryEncryptionMetadata" }, "fingerprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" } }, "required": ["algorithm", "encryption"], "type": "object" } ] }, "DiscoveryPuTTYKeyMetadata": { "allOf": [ { "properties": { "comment": { "type": "string" }, "private_key": { "$ref": "#/components/schemas/DiscoveryPrivateKeyMetadata" }, "private_mac": { "type": "string" }, "public_key": { "$ref": "#/components/schemas/DiscoveryPublicKeyMetadata" }, "version": { "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "version", "comment", "public_key", "private_key", "private_mac" ], "type": "object" } ] }, "DiscoveryPublicKeyMetadata": { "allOf": [ { "properties": { "algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "fingerprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" } }, "required": ["algorithm"], "type": "object" } ] }, "DiscoveryResourceSummary": { "allOf": [ { "properties": { "database_count": { "type": "integer" }, "fs_known_agents_count": { "nullable": true, "type": "integer" }, "source_code_repo_count": { "nullable": true, "type": "integer" } }, "required": ["database_count"], "type": "object" } ] }, "DiscoveryRevokedCertificate": { "allOf": [ { "properties": { "revoked_at": { "type": "string" }, "serial": { "type": "string" } }, "required": ["serial", "revoked_at"], "type": "object" } ] }, "DiscoveryRiskLevel": { "enum": ["critical", "high", "medium", "low", "good"], "type": "string" }, "DiscoveryRsaEncryptionPaddingPolicy": { "description": "RSA encryption padding policy.", "oneOf": [ { "properties": { "OAEP": { "$ref": "#/components/schemas/DiscoveryRsaEncryptionPaddingPolicyOaep" } }, "required": ["OAEP"], "title": "DiscoveryRsaEncryptionPaddingPolicyVariantOaep", "type": "object" }, { "properties": { "PKCS1_V15": { "properties": {}, "type": "object" } }, "required": ["PKCS1_V15"], "title": "DiscoveryRsaEncryptionPaddingPolicyVariantPkcs1V15", "type": "object" }, { "properties": { "RAW_DECRYPT": { "properties": {}, "type": "object" } }, "required": ["RAW_DECRYPT"], "title": "DiscoveryRsaEncryptionPaddingPolicyVariantRawDecrypt", "type": "object" } ] }, "DiscoveryRsaEncryptionPaddingPolicyOaep": { "allOf": [ { "description": "The Optional Asymmetric Encryption Padding scheme, as defined\nin RFC 8017 (PKCS #1 version 2.2)", "properties": { "mgf": { "$ref": "#/components/schemas/DiscoveryMgfPolicy" } }, "type": "object" } ] }, "DiscoveryRsaEncryptionPolicy": { "allOf": [ { "description": "Constraints on RSA encryption parameters. In general, if a constraint is not specified, anything is allowed.", "properties": { "padding": { "$ref": "#/components/schemas/DiscoveryRsaEncryptionPaddingPolicy" } }, "type": "object" } ] }, "DiscoveryRsaOptionsPolicy": { "allOf": [ { "properties": { "encryption_policy": { "items": { "$ref": "#/components/schemas/DiscoveryRsaEncryptionPolicy" }, "nullable": true, "type": "array" }, "minimum_key_length": { "description": "The minimum allowed key length. This is only relevant for group or account cryptographic\npolicies (and hence has no effect in an RSA policy on a specific key).", "maximum": 4294967295, "minimum": 0, "nullable": true, "type": "integer" }, "signature_policy": { "description": "Signature policy for an RSA key. When doing a signature operation, the policies are\nevaluated against the specified parameters one by one. If one matches, the operation is\nallowed. If none match, including if the policy list is empty, the operation is disallowed.\nMissing optional parameters will have their defaults specified according to the matched\npolicy. The default for new keys is `[{}]` (no constraints).\nIf (part of) a constraint is not specified, anything is allowed for that constraint.", "items": { "$ref": "#/components/schemas/DiscoveryRsaSignaturePolicy" }, "nullable": true, "type": "array" } }, "type": "object" } ] }, "DiscoveryRsaSignaturePaddingPolicy": { "description": "RSA signature padding policy.", "oneOf": [ { "properties": { "PSS": { "$ref": "#/components/schemas/DiscoveryRsaSignaturePaddingPolicyPss" } }, "required": ["PSS"], "title": "DiscoveryRsaSignaturePaddingPolicyVariantPss", "type": "object" }, { "properties": { "PKCS1_V15": { "properties": {}, "type": "object" } }, "required": ["PKCS1_V15"], "title": "DiscoveryRsaSignaturePaddingPolicyVariantPkcs1V15", "type": "object" } ] }, "DiscoveryRsaSignaturePaddingPolicyPss": { "allOf": [ { "properties": { "mgf": { "$ref": "#/components/schemas/DiscoveryMgfPolicy" } }, "type": "object" } ] }, "DiscoveryRsaSignaturePolicy": { "allOf": [ { "description": "Constraints on RSA signature parameters. In general, if a constraint is not specified, anything is allowed.", "properties": { "padding": { "$ref": "#/components/schemas/DiscoveryRsaSignaturePaddingPolicy" } }, "type": "object" } ] }, "DiscoveryScan": { "allOf": [ { "description": "Scan in Predjama.", "properties": { "acct_id": { "format": "uuid", "type": "string" }, "connection_id": { "format": "uuid", "type": "string" }, "created_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "ended_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "group_id": { "format": "uuid", "type": "string" }, "last_updated_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" }, "scan_errors": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "scan_id": { "format": "uuid", "type": "string" }, "scan_status": { "$ref": "#/components/schemas/DiscoveryScanStatus" } }, "required": [ "acct_id", "connection_id", "created_at", "group_id", "last_updated_at", "scan_id", "scan_status" ], "type": "object" } ] }, "DiscoveryScanInventoryObject": { "allOf": [ { "description": "ScanInventoryObject -- represents an external computational resource info fetched during a scan", "properties": { "acct_id": { "format": "uuid", "type": "string" }, "details": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectDetails" }, "group_id": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "inventory_object": { "$ref": "#/components/schemas/DiscoveryInventoryObject" }, "scan_id": { "format": "uuid", "type": "string" }, "scanned_at": { "example": "20170509T070912Z", "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$", "type": "string" } }, "required": [ "acct_id", "details", "group_id", "id", "scan_id", "scanned_at" ], "type": "object" } ] }, "DiscoveryScanInventoryObjectDetails": { "discriminator": { "mapping": { "aws": "DiscoveryScanInventoryObjectDetailsVariantAws", "azure": "DiscoveryScanInventoryObjectDetailsVariantAzure", "dsm": "DiscoveryScanInventoryObjectDetailsVariantDsm", "on_prem": "DiscoveryScanInventoryObjectDetailsVariantOnPrem" }, "propertyName": "$type" }, "oneOf": [ { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectDetailsVariantAws" }, { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectDetailsVariantAzure" }, { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectDetailsVariantOnPrem" }, { "$ref": "#/components/schemas/DiscoveryScanInventoryObjectDetailsVariantDsm" } ] }, "DiscoveryScanInventoryObjectDetailsVariantAws": { "allOf": [ { "properties": { "$type": { "enum": ["aws"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAwsObject" } ] }, "DiscoveryScanInventoryObjectDetailsVariantAzure": { "allOf": [ { "properties": { "$type": { "enum": ["azure"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryAzureObject" } ] }, "DiscoveryScanInventoryObjectDetailsVariantDsm": { "allOf": [ { "properties": { "$type": { "enum": ["dsm"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryDsmObject" } ] }, "DiscoveryScanInventoryObjectDetailsVariantOnPrem": { "allOf": [ { "properties": { "$type": { "enum": ["on_prem"], "type": "string" } }, "required": ["$type"], "type": "object" }, { "$ref": "#/components/schemas/DiscoveryOnPremObject" } ] }, "DiscoveryScanInventoryObjectReference": { "allOf": [ { "properties": { "id": { "format": "uuid", "type": "string" }, "scan_id": { "format": "uuid", "type": "string" } }, "required": ["id", "scan_id"], "type": "object" } ] }, "DiscoveryScanInventoryObjects": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryScanInventoryObject" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryScanInventoryObjectsParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScanParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScanStatus": { "enum": ["in_progress", "completed", "stopped", "pending", "failed"], "type": "string" }, "DiscoveryScannedAwsAccount": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryScannedAwsAccountDetails" }, "id": { "type": "string" }, "regions": { "items": { "$ref": "#/components/schemas/DiscoveryAwsRegion" }, "type": "array", "uniqueItems": true } }, "required": ["id", "regions"], "type": "object" } ] }, "DiscoveryScannedAwsAccountDetails": { "allOf": [ { "properties": { "name": { "nullable": true, "type": "string" } }, "type": "object" } ] }, "DiscoveryScannedAwsAccountsParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScannedAwsAccountsResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryScannedAwsAccount" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryScannedAzureSubscription": { "allOf": [ { "properties": { "details": { "$ref": "#/components/schemas/DiscoveryScannedAzureSubscriptionDetails" }, "id": { "format": "uuid", "type": "string" }, "regions": { "items": { "$ref": "#/components/schemas/DiscoveryAzureRegion" }, "type": "array", "uniqueItems": true }, "resource_groups": { "items": { "$ref": "#/components/schemas/DiscoveryAzureResourceGroup" }, "type": "array" } }, "required": ["id", "details", "resource_groups", "regions"], "type": "object" } ] }, "DiscoveryScannedAzureSubscriptionDetails": { "allOf": [ { "properties": { "name": { "type": "string" } }, "required": ["name"], "type": "object" } ] }, "DiscoveryScannedAzureSubscriptionsParams": { "allOf": [ { "properties": { "filter": { "type": "string" }, "limit": { "type": "integer" }, "previous_id": { "format": "uuid", "type": "string" }, "previous_sort_value": { "type": "string" }, "sort_by": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScannedAzureSubscriptionsResponse": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryScannedAzureSubscription" }, "type": "array" } }, "required": ["items"], "type": "object" } ] }, "DiscoveryScannedServicesReportByServiceTypeParams": { "allOf": [ { "properties": { "filter": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScannedServicesReportByViolationTypeParams": { "allOf": [ { "properties": { "filter": { "type": "string" } }, "type": "object" } ] }, "DiscoveryScannedServicesResponseByServiceType": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryServiceViolationMetrics" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryServicesMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoveryScannedServicesResponseByViolationType": { "allOf": [ { "properties": { "items": { "items": { "$ref": "#/components/schemas/DiscoveryViolationTypeMetrics" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/DiscoveryServicesMetadata" } }, "required": ["items", "metadata"], "type": "object" } ] }, "DiscoverySecretOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoverySeedOptionsPolicy": { "allOf": [ { "properties": { "random_iv": { "nullable": true, "type": "boolean" } }, "type": "object" } ] }, "DiscoveryServiceMetadataMetrics": { "allOf": [ { "properties": { "filtered_count": { "type": "integer" }, "total_count": { "type": "integer" } }, "required": ["total_count", "filtered_count"], "type": "object" } ] }, "DiscoveryServiceViolationMetrics": { "allOf": [ { "properties": { "cloud_provider_service_type": { "$ref": "#/components/schemas/DiscoveryCloudProviderServiceType" }, "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violations": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" } }, "required": [ "cloud_provider_service_type", "overall_risk", "violations" ], "type": "object" } ] }, "DiscoveryServiceViolationMetricsWithOverallRisk": { "allOf": [ { "properties": { "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "total_resources": { "type": "integer" }, "violation_metrics": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationDetails" }, "type": "object" } }, "required": [ "overall_risk", "total_resources", "violation_metrics" ], "type": "object" } ] }, "DiscoveryServicesMetadata": { "allOf": [ { "properties": { "scan_inventory_provider_metrics": { "$ref": "#/components/schemas/DiscoveryCspServicesMetadata" }, "service_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" }, "violation_metrics": { "$ref": "#/components/schemas/DiscoveryServiceMetadataMetrics" } }, "required": [ "violation_metrics", "service_metrics", "scan_inventory_provider_metrics" ], "type": "object" } ] }, "DiscoverySlip10OptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "DiscoverySshMetadata": { "oneOf": [ { "properties": { "open_ssh_public_key": { "$ref": "#/components/schemas/DiscoveryOpenSshPublicKeyMetadata" } }, "required": ["open_ssh_public_key"], "title": "DiscoverySshMetadataVariantOpenSshPublicKey", "type": "object" }, { "properties": { "open_ssh_private_key": { "$ref": "#/components/schemas/DiscoveryOpenSshPrivateKeyMetadata" } }, "required": ["open_ssh_private_key"], "title": "DiscoverySshMetadataVariantOpenSshPrivateKey", "type": "object" }, { "properties": { "putty_key": { "$ref": "#/components/schemas/DiscoveryPuTTYKeyMetadata" } }, "required": ["putty_key"], "title": "DiscoverySshMetadataVariantPuttyKey", "type": "object" } ] }, "DiscoverySymmetricKeyMetadata": { "allOf": [ { "properties": { "algorithm": { "$ref": "#/components/schemas/DiscoveryCryptographicAlgorithm" }, "encryption": { "$ref": "#/components/schemas/DiscoveryEncryptionMetadata" }, "fingerprint": { "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "nullable": true, "type": "array" } }, "required": ["algorithm", "encryption"], "type": "object" } ] }, "DiscoveryTrustedCertificateMetadata": { "allOf": [ { "properties": { "certificate": { "$ref": "#/components/schemas/DiscoveryCertificateMetadata" }, "extended_usage": { "$ref": "#/components/schemas/DiscoveryExtendedUsage" } }, "required": ["certificate"], "type": "object" } ] }, "DiscoveryViolation": { "enum": [ "shared_keys", "expired_keys", "exportable_keys", "noncompliant_keys", "csp_generated_keys", "keys_without_expiry", "unused_keys", "quantum_vulnerable_keys", "keys_with_rotation_disabled", "cross_account_keys", "shared_certificate", "expired_certificate", "non_compliant_certificate_by_key_algorithm", "non_compliant_certificate_by_signature_algorithm", "overly_permissive_certificate_usage", "overly_permissive_key_usage", "overly_permissive_key_management", "services_encrypted_with_overly_permissive_usage_key", "services_encrypted_with_overly_permissive_management_key", "unencrypted_services", "services_encrypted_with_shared_key", "services_encrypted_with_noncompliant_key", "services_encrypted_with_soft_deleted_key", "services_encrypted_with_purged_key", "services_encrypted_with_expired_key", "services_encrypted_with_exportable_key", "services_encrypted_with_quantum_vulnerable_key", "services_encrypted_with_csp_generated_key", "services_encrypted_with_platform_managed_key", "services_encrypted_with_cross_account_key" ], "type": "string" }, "DiscoveryViolationDetails": { "allOf": [ { "properties": { "count": { "type": "integer" }, "risk_level": { "$ref": "#/components/schemas/DiscoveryRiskLevel" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryViolationMetrics": { "allOf": [ { "description": "A structure to store the violation metrics for each violation.", "properties": { "count": { "type": "integer" } }, "required": ["count"], "type": "object" } ] }, "DiscoveryViolationTypeMetrics": { "allOf": [ { "properties": { "overall_risk": { "$ref": "#/components/schemas/DiscoveryRiskLevel" }, "violation": { "$ref": "#/components/schemas/DiscoveryViolation" }, "violations_by_service": { "additionalProperties": { "$ref": "#/components/schemas/DiscoveryViolationMetrics" }, "type": "object" } }, "required": ["violation", "overall_risk", "violations_by_service"], "type": "object" } ] }, "DiscoveryXmssOptionsPolicy": { "allOf": [ { "properties": {}, "type": "object" } ] }, "OauthTokenError": { "properties": { "error": { "$ref": "#/components/schemas/OauthTokenErrorCode" }, "error_description": { "type": "string" }, "error_uri": { "type": "string" } }, "required": ["error", "error_description"], "type": "object" }, "OauthTokenErrorCode": { "description": "Conforms to RFC 6749 Section 5.2.", "enum": [ "invalid_client", "invalid_grant", "invalid_request", "invalid_scope", "unauthorized_client", "unsupported_grant_type" ], "type": "string" }, "OauthTokenResponse": { "example": { "access_token": "2YotnFZFEjr1zCsicMWpAA", "expires_in": 3600, "token_type": "Bearer" }, "properties": { "access_token": { "type": "string" }, "expires_in": { "description": "Token lifetime in seconds.", "type": "integer" }, "token_type": { "type": "string" } }, "required": ["access_token", "token_type", "expires_in"], "type": "object" } }, "securitySchemes": { "Oauth2ClientCredentials": { "description": "OAuth 2.0 client credential flow, see https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.", "flows": { "clientCredentials": { "scopes": {}, "tokenUrl": "https://api.armor.fortanix.com/api/v1/iam/session/oauth2/token" } }, "type": "oauth2" } } }, "info": { "description": "**API of the Fortanix Unified Data and AI Security Platform**\n\nThe API client *must* follow HTTP redirects, including 308 redirects. Many HTTP libraries (such as Python Requests, JavaScript fetch) do this by default. With cURL, you must pass `--location`.\n", "title": "Armor API", "version": "0.1.0" }, "openapi": "3.0.0", "paths": { "/api/v1/discovery/connections": { "get": { "description": "Get all connections", "operationId": "GetAllConnections", "parameters": [ { "$ref": "#/components/parameters/DiscoveryGetAllConnectionsParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryGetAllConnectionsResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get all connections", "tags": ["DiscoveryConnection"] } }, "/api/v1/discovery/connections/{id}": { "get": { "description": "Get a specific connection", "operationId": "GetConnection", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryConnection" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get a specific connection", "tags": ["DiscoveryConnection"] } }, "/api/v1/discovery/inventory_objects": { "get": { "description": "Get Inventory Objects.", "operationId": "GetInventoryObjects", "parameters": [ { "$ref": "#/components/parameters/DiscoveryInventoryObjectsParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryInventoryObjectsResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Inventory Objects.", "tags": ["DiscoveryInventory"] } }, "/api/v1/discovery/inventory_objects/{id}": { "get": { "description": "Get Inventory Object.", "operationId": "GetInventoryObject", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryInventoryObject" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Inventory Object.", "tags": ["DiscoveryInventory"] } }, "/api/v1/discovery/policies": { "get": { "description": "Get all policies", "operationId": "GetAllPolicies", "parameters": [ { "$ref": "#/components/parameters/DiscoveryGetAllPoliciesParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryGetAllPoliciesResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get all policies", "tags": ["DiscoveryPolicies"] } }, "/api/v1/discovery/policies/{id}": { "get": { "description": "Get a specific Policy", "operationId": "GetPolicy", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryPolicy" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get a specific Policy", "tags": ["DiscoveryPolicies"] } }, "/api/v1/discovery/pqc/connections": { "get": { "description": "Get List of Connections for PQC Report.", "operationId": "GetPqcReportConnections", "parameters": [ { "$ref": "#/components/parameters/DiscoveryPqcReportConnectionParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryPqcReportConnectionsResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get List of Connections for PQC Report.", "tags": ["DiscoveryPqcReports"] } }, "/api/v1/discovery/pqc/report": { "get": { "description": "Get Cumulative PQC Report.", "operationId": "GetCumulativePqcReport", "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryPqcCumulativeReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Cumulative PQC Report.", "tags": ["DiscoveryPqcReports"] } }, "/api/v1/discovery/pqc/services": { "get": { "description": "Get List of Services for PQC Report.", "operationId": "GetPqcReportServices", "parameters": [ { "$ref": "#/components/parameters/DiscoveryPqcReportServiceParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryPqcReportServicesResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get List of Services for PQC Report.", "tags": ["DiscoveryPqcReports"] } }, "/api/v1/discovery/scans": { "get": { "description": "Get all scans.", "operationId": "GetAllScans", "parameters": [ { "$ref": "#/components/parameters/DiscoveryScanParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryGetAllScansResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get all scans.", "tags": ["DiscoveryScan"] } }, "/api/v1/discovery/scans/{id}": { "get": { "description": "Get a scan.", "operationId": "GetScan", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScan" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get a scan.", "tags": ["DiscoveryScan"] } }, "/api/v1/discovery/scans/{id}/accounts/aws": { "get": { "description": "Search Scanned account names", "operationId": "GetScannedAwsAccounts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryScannedAwsAccountsParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScannedAwsAccountsResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Search Scanned account names", "tags": ["DiscoveryAwsReports"] } }, "/api/v1/discovery/scans/{id}/assessment_report/aws": { "get": { "description": "Get Scan Assessment report.", "operationId": "GetAwsScanAssessmentReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAwsScanAssessmentReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Scan Assessment report.", "tags": ["DiscoveryAwsReports"] } }, "/api/v1/discovery/scans/{id}/assessment_report/azure": { "get": { "description": "Get Azure Scanned Assessment report", "operationId": "GetAzureScanAssessmentReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAzureScanAssessmentReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Azure Scanned Assessment report", "tags": ["DiscoveryAzureReports"] } }, "/api/v1/discovery/scans/{id}/assessment_report/on_prem/database": { "get": { "description": "Get On-Prem Database Scanned Assessment report", "operationId": "GetOnpremDatabaseScanAssessmentReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseScanAssessmentReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Database Scanned Assessment report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/assessment_report/on_prem/filesystem": { "get": { "description": "Get On-Prem Filesystem Assessment report", "operationId": "GetOnPremFsScanAssessmentReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremFsScanAssessmentReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Filesystem Assessment report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/assessment_report/on_prem/source_code": { "get": { "description": "Get On-Prem Source Code Scanned Assessment report", "operationId": "GetOnpremSourceCodeScanAssessmentReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeScanAssessmentReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Source Code Scanned Assessment report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/key_usage_report/aws": { "get": { "description": "Get Scan Keys report.", "operationId": "GetAwsScanKeyUsageReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryAwsKeyUsageParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAwsKeyUsageResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Scan Keys report.", "tags": ["DiscoveryAwsReports"] } }, "/api/v1/discovery/scans/{id}/key_usage_report/azure": { "get": { "description": "Get Scan Keys report.", "operationId": "GetAzureScanKeyUsageReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryAzureKeyUsageParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAzureKeyUsageResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Scan Keys report.", "tags": ["DiscoveryAzureReports"] } }, "/api/v1/discovery/scans/{id}/pqc/report": { "get": { "description": "Get PQC Report for a single connection.", "operationId": "GetPqcReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryPqcReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get PQC Report for a single connection.", "tags": ["DiscoveryPqcReports"] } }, "/api/v1/discovery/scans/{id}/scan_inventory_objects": { "get": { "description": "List Scan Inventory objects.", "operationId": "GetScanInventoryObjects", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryScanInventoryObjectsParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScanInventoryObjects" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "List Scan Inventory objects.", "tags": ["DiscoveryScanInventory"] } }, "/api/v1/discovery/scans/{id}/services_report/aws/by_account": { "get": { "description": "Get AWS Services report grouped by account.", "operationId": "GetAwsServicesReportGroupedByAccounts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryAwsScannedServicesReportByAccountParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAwsScannedServicesResponseByAccount" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get AWS Services report grouped by account.", "tags": ["DiscoveryServicesReports"] } }, "/api/v1/discovery/scans/{id}/services_report/azure/by_subscription": { "get": { "description": "Get Azure Services report grouped by subscription.", "operationId": "GetAzureServicesReportGroupedBySubscriptions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryAzureScannedServicesReportBySubscriptionParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAzureScannedServicesResponseBySubscription" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Azure Services report grouped by subscription.", "tags": ["DiscoveryServicesReports"] } }, "/api/v1/discovery/scans/{id}/services_report/by_service": { "get": { "description": "Get Services report grouped by service type.", "operationId": "GetServicesReportGroupedByServiceType", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryScannedServicesReportByServiceTypeParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScannedServicesResponseByServiceType" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Services report grouped by service type.", "tags": ["DiscoveryServicesReports"] } }, "/api/v1/discovery/scans/{id}/services_report/by_violation": { "get": { "description": "Get Services report grouped by violation type.", "operationId": "GetServicesReportGroupedByViolationType", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryScannedServicesReportByViolationTypeParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScannedServicesResponseByViolationType" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Services report grouped by violation type.", "tags": ["DiscoveryServicesReports"] } }, "/api/v1/discovery/scans/{id}/subscriptions/azure": { "get": { "description": "Get Azure Scanned Subscriptions", "operationId": "GetScannedAzureSubscriptions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/DiscoveryScannedAzureSubscriptionsParams" } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScannedAzureSubscriptionsResponse" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Azure Scanned Subscriptions", "tags": ["DiscoveryAzureReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/aws": { "get": { "description": "Get Scan report.", "operationId": "GetAwsScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAwsSummaryData" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Scan report.", "tags": ["DiscoveryAwsReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/azure": { "get": { "description": "Get Summary Report for Azure scan.", "operationId": "GetAzureScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryAzureSummaryData" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get Summary Report for Azure scan.", "tags": ["DiscoveryAzureReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/dsm": { "get": { "description": "Get DSM Summary report", "operationId": "GetDsmScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryDsmScanSummaryData" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get DSM Summary report", "tags": ["DiscoveryDsmReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/on_prem/database": { "get": { "description": "Get On-Prem Database Scanned Summary report", "operationId": "GetOnpremDatabaseScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremDatabaseScanSummaryReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Database Scanned Summary report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/on_prem/discovery": { "get": { "description": "Get On-Prem Scanned Assessment report", "operationId": "GetOnpremDiscoveryScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremScanSummaryReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Scanned Assessment report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/on_prem/filesystem": { "get": { "description": "Get On-Prem Filesystem Summary report", "operationId": "GetOnPremFsScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremFsScanSummaryReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Filesystem Summary report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{id}/summary_report/on_prem/source_code": { "get": { "description": "Get On-Prem Source Code Scanned Summary report", "operationId": "GetOnpremSourceCodeScanSummaryReport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryOnPremSourceCodeScanSummaryReport" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get On-Prem Source Code Scanned Summary report", "tags": ["DiscoveryOnPremReports"] } }, "/api/v1/discovery/scans/{scan_id}/scan_inventory_objects/{scan_inventory_object_id}": { "get": { "description": "Get a scan inventory object", "operationId": "GetScanInventoryObject", "parameters": [ { "in": "path", "name": "scan_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "scan_inventory_object_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "2XX": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryScanInventoryObject" } } }, "description": "Success result" } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Get a scan inventory object", "tags": ["DiscoveryScanInventory"] } }, "/api/v1/iam/session/oauth2/token": { "post": { "description": "Authenticate using the Oauth 2.0 Client Credentials flow.\n\nTo call this you must provide the form url encoded app ID and the form url encoded API key in the form of a Basic auth header.\n", "operationId": "OauthToken", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "grant_type": { "enum": ["client_credentials"], "type": "string" } } } } }, "description": "Conforms to RFC 6749 Section 4.4.2.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OauthTokenResponse" } } }, "description": "Success result." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OauthTokenError" } } }, "description": "Invalid credentials." } }, "summary": "Authenticate with a token.", "tags": ["Authentication"] } }, "/api/v1/iam/session/terminate": { "post": { "description": "Terminate the current session.", "operationId": "Terminate", "responses": { "204": { "description": "Nothing is returned on success." } }, "security": [ { "Oauth2ClientCredentials": [] } ], "summary": "Terminate the current session.", "tags": ["Authentication"] } } }, "servers": [ { "url": "https://api.armor.fortanix.com" } ], "tags": [ { "description": "APIs regarding creating or ending a session.", "name": "Authentication" }, { "description": "APIs regarding obtaining details about the connection.", "name": "DiscoveryConnection" }, { "description": "APIs regarding obtaining details about the policies.", "name": "DiscoveryPolicies" }, { "description": "APIs regarding obtaining details about the scans.", "name": "DiscoveryScan" }, { "description": "APIs regarding obtaining the reports related to AWS.", "name": "DiscoveryAwsReports" }, { "description": "APIs regarding obtaining the reports related to Azure.", "name": "DiscoveryAzureReports" }, { "description": "APIs regarding obtaining the reports for Services.", "name": "DiscoveryServicesReports" }, { "description": "APIs regarding obtaining the PQC reports.", "name": "DiscoveryPqcReports" }, { "description": "APIs regarding obtaining the reports related to DSM.", "name": "DiscoveryDsmReports" }, { "description": "APIs regarding obtaining the details about the inventory objects.", "name": "DiscoveryInventory" }, { "description": "APIs regarding obtaining the reports related to On-Prem infrastructure.", "name": "DiscoveryOnPremReports" }, { "description": "APIs regarding obtaining the details about the inventory objects associated to a scan.", "name": "DiscoveryScanInventory" } ] }