> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xsiam-api/aspm-cicd-and-application-security/models.md).

# Models

## The CriteriaType.Cloud object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaType.Cloud":{"enum":["cloud"],"type":"string","description":"Criteria Type. Allowed values - `cloud`."}}}}
```

## The ApplicationMetadataCloud object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The CriteriaDefinitionType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"}}}}
```

## The CodeProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"}}}}
```

## The RunProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"}}}}
```

## The SectionProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"}}}}
```

## The CriteriaDefinition object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"}}}}
```

## The CloudCriteriaConfig object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CloudCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCloud"}},"title":"Cloud Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The CodeCriteriaConfig object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CodeCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{"type":"string"}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCode"}},"title":"Code Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."}}}}
```

## The ApplicationMetadataCode object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."}}}}
```

## The BusinessOwnerMetaData object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."}}}}
```

## The CriteriaCreationMethod object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaCreationMethod":{"enum":["manual","automatic"],"type":"string","description":"Creation method for the criteria. Possible values:\n -`manual`: For the criteria created manually.\n -`automatic`: Criteria that are automatically created."}}}}
```

## The RefreshStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."}}}}
```

## The CriteriaMetadata object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaMetadata":{"type":"object","additionalProperties":false,"description":"Additional metadata for the criteria.","properties":{"applicationCount":{"type":"number","format":"double","description":"The number of associated applications."},"assetCount":{"type":"number","format":"double","description":"The number of associated assets."},"refreshStatus":{"$ref":"#/components/schemas/RefreshStatus"},"deletedFromUai":{"type":"boolean","description":"Indicates whether the resource has been deleted from UAI."}}},"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."}}}}
```

## The CriteriaDTOCode object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaDTOCode":{"type":"object","additionalProperties":false,"description":"Code Criteria details.","title":"Code Criteria","required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Code"},"config":{"$ref":"#/components/schemas/CodeCriteriaConfig"}}},"CriteriaCreationMethod":{"enum":["manual","automatic"],"type":"string","description":"Creation method for the criteria. Possible values:\n -`manual`: For the criteria created manually.\n -`automatic`: Criteria that are automatically created."},"CriteriaMetadata":{"type":"object","additionalProperties":false,"description":"Additional metadata for the criteria.","properties":{"applicationCount":{"type":"number","format":"double","description":"The number of associated applications."},"assetCount":{"type":"number","format":"double","description":"The number of associated assets."},"refreshStatus":{"$ref":"#/components/schemas/RefreshStatus"},"deletedFromUai":{"type":"boolean","description":"Indicates whether the resource has been deleted from UAI."}}},"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."},"CriteriaType.Code":{"enum":["code"],"type":"string","description":"Criteria Type."},"CodeCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{"type":"string"}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCode"}},"title":"Code Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."}}}}
```

## The CriteriaType.Code object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaType.Code":{"enum":["code"],"type":"string","description":"Criteria Type."}}}}
```

## The CriteriaDTOCloud object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaDTOCloud":{"type":"object","additionalProperties":false,"required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Cloud"},"config":{"$ref":"#/components/schemas/CloudCriteriaConfig"}},"description":"Cloud Criteria details.","title":"Cloud Criteria"},"CriteriaCreationMethod":{"enum":["manual","automatic"],"type":"string","description":"Creation method for the criteria. Possible values:\n -`manual`: For the criteria created manually.\n -`automatic`: Criteria that are automatically created."},"CriteriaMetadata":{"type":"object","additionalProperties":false,"description":"Additional metadata for the criteria.","properties":{"applicationCount":{"type":"number","format":"double","description":"The number of associated applications."},"assetCount":{"type":"number","format":"double","description":"The number of associated assets."},"refreshStatus":{"$ref":"#/components/schemas/RefreshStatus"},"deletedFromUai":{"type":"boolean","description":"Indicates whether the resource has been deleted from UAI."}}},"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."},"CriteriaType.Cloud":{"enum":["cloud"],"type":"string","description":"Criteria Type. Allowed values - `cloud`."},"CloudCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCloud"}},"title":"Cloud Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The CriteriaDTO object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CriteriaDTO":{"anyOf":[{"$ref":"#/components/schemas/CriteriaDTOCode"},{"$ref":"#/components/schemas/CriteriaDTOCloud"}]},"CriteriaDTOCode":{"type":"object","additionalProperties":false,"description":"Code Criteria details.","title":"Code Criteria","required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Code"},"config":{"$ref":"#/components/schemas/CodeCriteriaConfig"}}},"CriteriaCreationMethod":{"enum":["manual","automatic"],"type":"string","description":"Creation method for the criteria. Possible values:\n -`manual`: For the criteria created manually.\n -`automatic`: Criteria that are automatically created."},"CriteriaMetadata":{"type":"object","additionalProperties":false,"description":"Additional metadata for the criteria.","properties":{"applicationCount":{"type":"number","format":"double","description":"The number of associated applications."},"assetCount":{"type":"number","format":"double","description":"The number of associated assets."},"refreshStatus":{"$ref":"#/components/schemas/RefreshStatus"},"deletedFromUai":{"type":"boolean","description":"Indicates whether the resource has been deleted from UAI."}}},"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."},"CriteriaType.Code":{"enum":["code"],"type":"string","description":"Criteria Type."},"CodeCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{"type":"string"}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCode"}},"title":"Code Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CriteriaDTOCloud":{"type":"object","additionalProperties":false,"required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Cloud"},"config":{"$ref":"#/components/schemas/CloudCriteriaConfig"}},"description":"Cloud Criteria details.","title":"Cloud Criteria"},"CriteriaType.Cloud":{"enum":["cloud"],"type":"string","description":"Criteria Type. Allowed values - `cloud`."},"CloudCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCloud"}},"title":"Cloud Criteria"},"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The PaginationResponse\_CriteriaDTO\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PaginationResponse_CriteriaDTO_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CriteriaDTO"},"type":"array"},"currentPage":{"type":"number","format":"double","description":"Current page number in the paginated response."},"totalPages":{"type":"number","format":"double","description":"Total number of pages for the paginated response."},"pageSize":{"type":"number","format":"double","description":"Number of entries in each page."},"totalItems":{"type":"number","format":"double","description":"Total number of items in the response."}},"required":["items","currentPage","pageSize","totalItems"],"type":"object","additionalProperties":false},"CriteriaDTO":{"anyOf":[{"$ref":"#/components/schemas/CriteriaDTOCode"},{"$ref":"#/components/schemas/CriteriaDTOCloud"}]},"CriteriaDTOCode":{"type":"object","additionalProperties":false,"description":"Code Criteria details.","title":"Code Criteria","required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Code"},"config":{"$ref":"#/components/schemas/CodeCriteriaConfig"}}},"CriteriaCreationMethod":{"enum":["manual","automatic"],"type":"string","description":"Creation method for the criteria. Possible values:\n -`manual`: For the criteria created manually.\n -`automatic`: Criteria that are automatically created."},"CriteriaMetadata":{"type":"object","additionalProperties":false,"description":"Additional metadata for the criteria.","properties":{"applicationCount":{"type":"number","format":"double","description":"The number of associated applications."},"assetCount":{"type":"number","format":"double","description":"The number of associated assets."},"refreshStatus":{"$ref":"#/components/schemas/RefreshStatus"},"deletedFromUai":{"type":"boolean","description":"Indicates whether the resource has been deleted from UAI."}}},"RefreshStatus":{"enum":["in_progress","done"],"type":"string","description":"The current refresh status."},"CriteriaType.Code":{"enum":["code"],"type":"string","description":"Criteria Type."},"CodeCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{"type":"string"}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCode"}},"title":"Code Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CriteriaDTOCloud":{"type":"object","additionalProperties":false,"required":["id","name","creationMethod","createdBy","createdAt","type","config"],"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."},"description":{"type":"string","description":"Criteria description."},"creationMethod":{"$ref":"#/components/schemas/CriteriaCreationMethod"},"createdBy":{"type":"string","description":"Owner of the criteria."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the criteria was updated."},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when the criteria was deleted."},"metadata":{"$ref":"#/components/schemas/CriteriaMetadata"},"type":{"$ref":"#/components/schemas/CriteriaType.Cloud"},"config":{"$ref":"#/components/schemas/CloudCriteriaConfig"}},"description":"Cloud Criteria details.","title":"Cloud Criteria"},"CriteriaType.Cloud":{"enum":["cloud"],"type":"string","description":"Criteria Type. Allowed values - `cloud`."},"CloudCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCloud"}},"title":"Cloud Criteria"},"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The CreateCriteriaResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateCriteriaResponse":{"properties":{"id":{"type":"string","description":"Unique Id of the criteria."},"name":{"type":"string","description":"Unique name of the criteria."}},"required":["id","name"],"type":"object","additionalProperties":false}}}}
```

## The CreateCriteriaRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateCriteriaRequest":{"type":"object","additionalProperties":false,"description":"Creates a new criteria object.","title":"CreateCriteriaRequest","required":["name","type","config"],"properties":{"name":{"type":"string","description":"Unique name for the criteria."},"description":{"type":"string","description":"Optional description for the criteria."},"type":{"$ref":"#/components/schemas/CriteriaType.Cloud"},"config":{"anyOf":[{"$ref":"#/components/schemas/CodeCriteriaConfig"},{"$ref":"#/components/schemas/CloudCriteriaConfig"}]}}},"CriteriaType.Cloud":{"enum":["cloud"],"type":"string","description":"Criteria Type. Allowed values - `cloud`."},"CodeCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{"type":"string"}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCode"}},"title":"Code Criteria"},"CriteriaDefinition":{"type":"array","items":{"type":"object","required":["type","provider"],"properties":{"type":{"$ref":"#/components/schemas/CriteriaDefinitionType"},"provider":{"$ref":"#/components/schemas/SectionProvider"},"filters":{"type":"array","description":"**Optional.** A list of filters to apply. If you choose to include the `filters` array, all fields within each filter object are required. Each filter object contains the following fields:\n","items":{"type":"object","required":["type","field","values"],"properties":{"type":{"enum":["equal","notEqual","contains","notContains"],"description":"The filter operation."},"field":{"enum":["repositoryName","organizationName","projectName"],"description":"The field to filter on."},"values":{"type":"array","description":"The values to match for the filter.","items":{"type":"string"}}}}},"tagKeys":{"type":"array","description":"The tag keys to include.","items":{"type":"string"}}}}},"CriteriaDefinitionType":{"enum":["tags","organization","project","repository"],"type":"string"},"SectionProvider":{"anyOf":[{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"}]},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"ApplicationMetadataCode":{"type":"object","additionalProperties":false,"required":["businessOwner","businessCriticality","exposedToInternetOverride"],"properties":{"businessOwner":{"$ref":"#/components/schemas/BusinessOwnerMetaData"},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"exposedToInternetOverride":{"type":"boolean","description":"Whether the asset is exposed to the internet."}}},"BusinessOwnerMetaData":{"enum":["none","organizationOwner","projectOwner","repositoryOwner"],"type":"string","description":"The metadata of the business owner."},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CloudCriteriaConfig":{"type":"object","additionalProperties":false,"required":["criteriaDefinitions","applicationMetaData"],"properties":{"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"criteriaDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"}},"criteriaPrettyName":{"type":"string","description":"A human-readable name for the criteria."},"criteriaPrettyNameTags":{"type":"array","description":"Tags associated with the criteria name.","items":{}},"applicationMetaData":{"$ref":"#/components/schemas/ApplicationMetadataCloud"}},"title":"Cloud Criteria"},"ApplicationMetadataCloud":{"properties":{"applicationNameSourceTags":{"type":"string","description":"Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay).\n If matching tag is not found, the application name is automatically generated by the system."},"businessCriticalitySourceTags":{"type":"string","description":"Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium."},"businessOwnerSourceTags":{"items":{"type":"string","description":"Specifies the application owner. If multiple values are present, they are concatenated and separated by commas."},"type":"array"},"businessUnitSourceTags":{"type":"string","description":"Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown."}},"type":"object","additionalProperties":false}}}}
```

## The GetIssueFixSuggestionResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"GetIssueFixSuggestionResponse":{"properties":{"issueId":{"type":"string","description":"Unique identifier for the issue."},"issueName":{"type":"string","description":"Name of the security issue."},"existingCodeBlock":{"type":"string","description":"Original vulnerable code."},"remediationInstruction":{"type":"string","description":"Manual remediation instructions."},"suggestedCodeBlock":{"type":"string","description":"Automated fix suggestions."}},"required":["issueId","issueName"],"type":"object","additionalProperties":false}}}}
```

## The TriggeredPr object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"TriggeredPr":{"properties":{"issueId":{"type":"string","description":"A unique identifier for issue."},"status":{"type":"string","enum":["triggered","automated_fix_not_available"],"description":"PR status. Possible values:\n -`triggered`: If the PR is in triggered state.\n -`automated_fix_not_available`: If the PR is in automated_fix_not_available state. "}},"required":["issueId","status"],"type":"object","additionalProperties":false}}}}
```

## The TriggerFixPrResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"TriggerFixPrResponse":{"properties":{"message":{"type":"string","description":"Error message if the process fails."},"triggeredPrs":{"items":{"$ref":"#/components/schemas/TriggeredPr"},"type":"array","description":"Status of each issue."},"status":{"type":"string","description":"Overall process status."},"remediationId":{"type":"string","description":"Unique identifier to track the remediation process"},"error":{"type":"string","description":" Error details if the process fails."}},"required":["message","triggeredPrs"],"type":"object","additionalProperties":false},"TriggeredPr":{"properties":{"issueId":{"type":"string","description":"A unique identifier for issue."},"status":{"type":"string","enum":["triggered","automated_fix_not_available"],"description":"PR status. Possible values:\n -`triggered`: If the PR is in triggered state.\n -`automated_fix_not_available`: If the PR is in automated_fix_not_available state. "}},"required":["issueId","status"],"type":"object","additionalProperties":false}}}}
```

## The TriggerFixPrPayload object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"TriggerFixPrPayload":{"properties":{"fixBranchName":{"type":"string","description":"The branch name for the fix pull request. If not specified, a custom branch will be used."},"title":{"type":"string","description":"The title for the fix pull request. If not specified, a default message will be used."},"issueIds":{"items":{"type":"string"},"type":"array","description":"A list of unique identifiers for the issues to be fixed. Maximum 10 IDs per request."}},"required":["issueIds"],"type":"object"}}}}
```

## The SaveFixResult object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SaveFixResult":{"properties":{"prUrl":{"type":"string","description":"URL of the created pull request."},"errorMessage":{"type":"string","description":"Error details if the process failed."},"remediationRepositoryId":{"type":"string","description":" Internal repository identifier."},"failureIssueIds":{"items":{"type":"string","description":"Issues Ids that could not be fixed."},"type":"array"},"successfulIssueIds":{"items":{"type":"string","description":"Issues Ids that were successfully fixed."},"type":"array"}},"required":["remediationRepositoryId","failureIssueIds","successfulIssueIds"],"type":"object"}}}}
```

## The FixStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FixStatus":{"properties":{"isProcessDone":{"type":"boolean","description":"Indicates whether all remediation processes are complete."},"results":{"items":{"$ref":"#/components/schemas/SaveFixResult"},"type":"array","description":" Remediation results grouped by repository."}},"required":["isProcessDone","results"],"type":"object"},"SaveFixResult":{"properties":{"prUrl":{"type":"string","description":"URL of the created pull request."},"errorMessage":{"type":"string","description":"Error details if the process failed."},"remediationRepositoryId":{"type":"string","description":" Internal repository identifier."},"failureIssueIds":{"items":{"type":"string","description":"Issues Ids that could not be fixed."},"type":"array"},"successfulIssueIds":{"items":{"type":"string","description":"Issues Ids that were successfully fixed."},"type":"array"}},"required":["remediationRepositoryId","failureIssueIds","successfulIssueIds"],"type":"object"}}}}
```

## The ApplicationConfigurationSettings object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationConfigurationSettings":{"type":"object","properties":{"keepApplicationRefresh":{"type":"boolean","description":"Indicates if the system is configured to automatically and periodically refresh the application's metadata and asset data."},"areSbomIssuesConsideredNew":{"type":"boolean","description":"Indicates if findings from Software Bill of Materials (SBOM) scans are treated as brand-new issues for tracking and compliance purposes."},"sla":{"type":"object","description":"Contains the Service Level Agreement (SLA) configurations, defining the resolution timeframes for various severity levels.","properties":{"CRITICAL":{"type":"object","description":"Defines the SLA target days for issues classified as CRITICAL severity.","properties":{"targetDays":{"type":"integer","description":"The number of calendar days set as the target for resolving issues of this specific severity level. A value of **0** indicates the SLA is waived or not enforced."}}},"HIGH":{"type":"object","description":"Defines the SLA target days for issues classified as HIGH severity.","properties":{"targetDays":{"type":"integer","description":"The number of calendar days set as the target for resolving issues of this specific severity level. A value of **0** indicates the SLA is waived or not enforced."}}},"MEDIUM":{"type":"object","description":"Defines the SLA target days for issues classified as MEDIUM severity.","properties":{"targetDays":{"type":"integer","description":"The number of calendar days set as the target for resolving issues of this specific severity level. A value of **0** indicates the SLA is waived or not enforced."}}},"LOW":{"type":"object","description":"Defines the SLA target days for issues classified as LOW severity.","properties":{"targetDays":{"type":"integer","description":"The number of calendar days set as the target for resolving issues of this specific severity level. A value of **0** indicates the SLA is waived or not enforced."}}},"approaching":{"type":"object","description":"Defines the early warning threshold that triggers notifications before an SLA is officially breached.","properties":{"targetDays":{"type":"integer","description":"The number of calendar days set as the target for defining the 'approaching' window."}}}}}}}}}}
```

## The CrudResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CrudResponse":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"boolean","description":"Displays the status of the application.","default":true},"applicationId":{"type":"string","description":"Displays the Asset ID of the application."}}}}}}
```

## The Category object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Category":{"enum":["Business Application"],"type":"string"}}}}
```

## The BusinessCriticality object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."}}}}
```

## The CreationType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreationType":{"enum":["Auto","Manual"],"type":"string","description":"Defines how the application asset is created."}}}}
```

## The Compliance object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Compliance":{"enum":["PCI-DSS","ISO 27001","SOX","NIST","GDPR","CCPA","HIPAA","FedRAMP"],"type":"string","description":"The compliance status or requirement category for an asset."}}}}
```

## The ApplicationAssetSelectionType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationAssetSelectionType":{"enum":["filter","assetIds"],"type":"string","description":"Method to select application assets."}}}}
```

## The ApplicationBuilderStartSection object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationBuilderStartSection":{"enum":["code","run"],"type":"string","description":"Identifies the functional section to which the asset selection applies."}}}}
```

## The BuildProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"}}}}
```

## The PolicyCondition object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PolicyCondition":{"type":"object","title":"PolicyCondition","description":"Defines the specific criteria (conditions) that will trigger the policy. You can combine multiple conditions to create complex rules for when the policy should be applied. If you combine multiple `Finding Type` values using `OR`, only the common fields across those types will be valid.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Selecting `Finding Type` determines which condition fields you can configure. Each `Finding Type` supports a specific set of condition fields. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table.","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the condition filter should match. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."}}}}
```

## The PolicyScope object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PolicyScope":{"type":"object","title":"PolicyScope","description":"Defines the type of assets to be evaluated by the policy (the scope). You can combine multiple conditions to create complex rules for when the policy should be applied.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Cannot be used if `assetGroupIds` are set.\n\nFor the list of available scope fields, see [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables).","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the matching criteria filter should match. To see which fields are allowed for each type, see the [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."}}}}
```

## The DeployProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"}}}}
```

## The Provider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"}}}}
```

## The CodeFilterType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."}}}}
```

## The RunFilterType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."}}}}
```

## The FilterType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."}}}}
```

## The ManualAndRunCriteriaApplicationAssetSelectionFilter object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."}}}}
```

## The ApplicationAssetSelectionFilterValues object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."}}}}
```

## The ApplicationAssetSelectionFilter object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationAssetSelectionFilter":{"anyOf":[{"$ref":"#/components/schemas/ManualAndRunCriteriaApplicationAssetSelectionFilter"},{"$ref":"#/components/schemas/ApplicationAssetSelectionFilterValues"},{"type":"string"}],"description":"Defines filter criteria to dynamically select application assets. This field supports one of the supported application asset selection filter types.","title":"Application Asset Selection Filter"},"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."},"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}}}}}
```

## The ApplicationAssetSelection object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationAssetSelection":{"type":"object","additionalProperties":false,"description":"Define the logic for how specific technical assets must be linked to this application.","required":["selectionType","section"],"properties":{"selectionType":{"$ref":"#/components/schemas/ApplicationAssetSelectionType"},"section":{"$ref":"#/components/schemas/ApplicationBuilderStartSection"},"filter":{"$ref":"#/components/schemas/ApplicationAssetSelectionFilter"},"assetIds":{"type":"array","description":"A list of unique identifiers representing the assets to be included.","items":{"type":"string"}}},"title":"Application Asset Selection"},"ApplicationAssetSelectionType":{"enum":["filter","assetIds"],"type":"string","description":"Method to select application assets."},"ApplicationBuilderStartSection":{"enum":["code","run"],"type":"string","description":"Identifies the functional section to which the asset selection applies."},"ApplicationAssetSelectionFilter":{"anyOf":[{"$ref":"#/components/schemas/ManualAndRunCriteriaApplicationAssetSelectionFilter"},{"$ref":"#/components/schemas/ApplicationAssetSelectionFilterValues"},{"type":"string"}],"description":"Defines filter criteria to dynamically select application assets. This field supports one of the supported application asset selection filter types.","title":"Application Asset Selection Filter"},"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."},"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}}}}}
```

## The CreateApplicationRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateApplicationRequest":{"type":"object","additionalProperties":false,"required":["name","businessCriticality","creationType","assetSelection"],"properties":{"name":{"type":"string","description":"A unique name for the application asset."},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"businessUnit":{"type":"string","description":"Business unit responsible for the asset."},"creationType":{"$ref":"#/components/schemas/CreationType"},"description":{"type":"string","description":"A brief description of the asset's purpose."},"compliance":{"$ref":"#/components/schemas/Compliance"},"businessOwner":{"type":"array","description":"A list of stakeholders responsible for the asset from the business side.","items":{"type":"string"}},"devOwner":{"type":"array","description":"A list of primary developers or engineering leads responsible for the code.","items":{"type":"string"}},"devOpsOwner":{"type":"array","description":"A list of SRE or DevOps engineers managing the infrastructure.","items":{"type":"string"}},"productManager":{"type":"array","description":"A list of product managers responsible for overseeing the application asset.","items":{"type":"string"}},"assetSelection":{"$ref":"#/components/schemas/ApplicationAssetSelection"}}},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CreationType":{"enum":["Auto","Manual"],"type":"string","description":"Defines how the application asset is created."},"Compliance":{"enum":["PCI-DSS","ISO 27001","SOX","NIST","GDPR","CCPA","HIPAA","FedRAMP"],"type":"string","description":"The compliance status or requirement category for an asset."},"ApplicationAssetSelection":{"type":"object","additionalProperties":false,"description":"Define the logic for how specific technical assets must be linked to this application.","required":["selectionType","section"],"properties":{"selectionType":{"$ref":"#/components/schemas/ApplicationAssetSelectionType"},"section":{"$ref":"#/components/schemas/ApplicationBuilderStartSection"},"filter":{"$ref":"#/components/schemas/ApplicationAssetSelectionFilter"},"assetIds":{"type":"array","description":"A list of unique identifiers representing the assets to be included.","items":{"type":"string"}}},"title":"Application Asset Selection"},"ApplicationAssetSelectionType":{"enum":["filter","assetIds"],"type":"string","description":"Method to select application assets."},"ApplicationBuilderStartSection":{"enum":["code","run"],"type":"string","description":"Identifies the functional section to which the asset selection applies."},"ApplicationAssetSelectionFilter":{"anyOf":[{"$ref":"#/components/schemas/ManualAndRunCriteriaApplicationAssetSelectionFilter"},{"$ref":"#/components/schemas/ApplicationAssetSelectionFilterValues"},{"type":"string"}],"description":"Defines filter criteria to dynamically select application assets. This field supports one of the supported application asset selection filter types.","title":"Application Asset Selection Filter"},"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."},"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}}}}}
```

## The Exposures object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Exposures":{"enum":["DeployedToProduction","SensitiveData","ExternalAccessible"],"type":"string","description":"Represents the risks the system identifies on assets.","title":"Exposures"}}}}
```

## The DataGovernance object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"DataGovernance":{"enum":["PII","PCI","Financial","PHI","Sensitive"],"type":"string","description":"Type of data governance applied to the asset."}}}}
```

## The ApplicationEnrichStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationEnrichStatus":{"enum":["IN_PROGRESS","NOT_IN_PROGRESS"],"type":"string","description":"Indicates whether asset enrichment is currently in progress."}}}}
```

## The ExtendedFields object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ExtendedFields":{"type":"object","additionalProperties":false,"description":"Exposure attributes associated with the asset.","required":["creationType","config"],"properties":{"criteriaId":{"type":"string","description":"A unique identifier of the criteria."},"criteriaName":{"type":"string","description":"Name of the criteria."},"risk":{"type":"number","format":"double","description":"Calculated risk score associated with the criteria or asset."},"id":{"type":"string","description":"Unique identifier of the resource."},"strongId":{"type":"string","description":"Globally unique, immutable identifier for the resource."},"name":{"type":"string","description":"Name of the application asset."},"description":{"type":"string","description":"Description providing additional details about the asset."},"exposures":{"type":"array","items":{"$ref":"#/components/schemas/Exposures"}},"coverage":{"type":"number","format":"double","description":"Represents the level of coverage applied to the asset."},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"businessUnit":{"type":"string","description":"Business unit responsible for the asset."},"creationType":{"$ref":"#/components/schemas/CreationType"},"businessOwner":{"type":"array","description":"Business owners responsible for the asset.","items":{"type":"string"}},"devOwner":{"type":"array","description":"Development owners responsible for building and maintaining the asset.","items":{"type":"string"}},"devOpsOwner":{"type":"array","description":"DevOps owners responsible for deployment and operations.","items":{"type":"string"}},"productManager":{"type":"array","description":"Product managers responsible for the asset.","items":{"type":"string"}},"dataGovernance":{"$ref":"#/components/schemas/DataGovernance"},"compliance":{"$ref":"#/components/schemas/Compliance"},"environments":{"type":"string","description":"Environment in which the asset is deployed (for example, development, staging, or production)."},"assetsCount":{"type":"number","format":"double","description":"Total number of assets included in the response."},"config":{"type":"object","description":"Configuration settings associated with the application.","required":["assetSelection"],"properties":{"lastRefreshDate":{"type":"string","format":"date-time","description":"Date and time when the application data was last refreshed."},"assetSelection":{"$ref":"#/components/schemas/ApplicationAssetSelection"}}},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the configuration was last updated."},"deletedAt":{"type":"string","format":"date-time","description":"Date and time when the configuration was deleted."},"enrichStatus":{"$ref":"#/components/schemas/ApplicationEnrichStatus"},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."}}},"Exposures":{"enum":["DeployedToProduction","SensitiveData","ExternalAccessible"],"type":"string","description":"Represents the risks the system identifies on assets.","title":"Exposures"},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CreationType":{"enum":["Auto","Manual"],"type":"string","description":"Defines how the application asset is created."},"DataGovernance":{"enum":["PII","PCI","Financial","PHI","Sensitive"],"type":"string","description":"Type of data governance applied to the asset."},"Compliance":{"enum":["PCI-DSS","ISO 27001","SOX","NIST","GDPR","CCPA","HIPAA","FedRAMP"],"type":"string","description":"The compliance status or requirement category for an asset."},"ApplicationAssetSelection":{"type":"object","additionalProperties":false,"description":"Define the logic for how specific technical assets must be linked to this application.","required":["selectionType","section"],"properties":{"selectionType":{"$ref":"#/components/schemas/ApplicationAssetSelectionType"},"section":{"$ref":"#/components/schemas/ApplicationBuilderStartSection"},"filter":{"$ref":"#/components/schemas/ApplicationAssetSelectionFilter"},"assetIds":{"type":"array","description":"A list of unique identifiers representing the assets to be included.","items":{"type":"string"}}},"title":"Application Asset Selection"},"ApplicationAssetSelectionType":{"enum":["filter","assetIds"],"type":"string","description":"Method to select application assets."},"ApplicationBuilderStartSection":{"enum":["code","run"],"type":"string","description":"Identifies the functional section to which the asset selection applies."},"ApplicationAssetSelectionFilter":{"anyOf":[{"$ref":"#/components/schemas/ManualAndRunCriteriaApplicationAssetSelectionFilter"},{"$ref":"#/components/schemas/ApplicationAssetSelectionFilterValues"},{"type":"string"}],"description":"Defines filter criteria to dynamically select application assets. This field supports one of the supported application asset selection filter types.","title":"Application Asset Selection Filter"},"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."},"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"ApplicationEnrichStatus":{"enum":["IN_PROGRESS","NOT_IN_PROGRESS"],"type":"string","description":"Indicates whether asset enrichment is currently in progress."}}}}
```

## The BasicPaginatedResponse\_ExtendedFields-Array\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BasicPaginatedResponse_ExtendedFields-Array_":{"type":"object","additionalProperties":false,"required":["data","hasNext"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedFields"}},"hasNext":{"type":"boolean","description":"Indicates whether additional results are available beyond the current page."}}},"ExtendedFields":{"type":"object","additionalProperties":false,"description":"Exposure attributes associated with the asset.","required":["creationType","config"],"properties":{"criteriaId":{"type":"string","description":"A unique identifier of the criteria."},"criteriaName":{"type":"string","description":"Name of the criteria."},"risk":{"type":"number","format":"double","description":"Calculated risk score associated with the criteria or asset."},"id":{"type":"string","description":"Unique identifier of the resource."},"strongId":{"type":"string","description":"Globally unique, immutable identifier for the resource."},"name":{"type":"string","description":"Name of the application asset."},"description":{"type":"string","description":"Description providing additional details about the asset."},"exposures":{"type":"array","items":{"$ref":"#/components/schemas/Exposures"}},"coverage":{"type":"number","format":"double","description":"Represents the level of coverage applied to the asset."},"businessCriticality":{"$ref":"#/components/schemas/BusinessCriticality"},"businessUnit":{"type":"string","description":"Business unit responsible for the asset."},"creationType":{"$ref":"#/components/schemas/CreationType"},"businessOwner":{"type":"array","description":"Business owners responsible for the asset.","items":{"type":"string"}},"devOwner":{"type":"array","description":"Development owners responsible for building and maintaining the asset.","items":{"type":"string"}},"devOpsOwner":{"type":"array","description":"DevOps owners responsible for deployment and operations.","items":{"type":"string"}},"productManager":{"type":"array","description":"Product managers responsible for the asset.","items":{"type":"string"}},"dataGovernance":{"$ref":"#/components/schemas/DataGovernance"},"compliance":{"$ref":"#/components/schemas/Compliance"},"environments":{"type":"string","description":"Environment in which the asset is deployed (for example, development, staging, or production)."},"assetsCount":{"type":"number","format":"double","description":"Total number of assets included in the response."},"config":{"type":"object","description":"Configuration settings associated with the application.","required":["assetSelection"],"properties":{"lastRefreshDate":{"type":"string","format":"date-time","description":"Date and time when the application data was last refreshed."},"assetSelection":{"$ref":"#/components/schemas/ApplicationAssetSelection"}}},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the configuration was last updated."},"deletedAt":{"type":"string","format":"date-time","description":"Date and time when the configuration was deleted."},"enrichStatus":{"$ref":"#/components/schemas/ApplicationEnrichStatus"},"unifyAcrossProviders":{"type":"boolean","description":"If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application."},"unifyWithinProvider":{"type":"boolean","description":"Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider."}}},"Exposures":{"enum":["DeployedToProduction","SensitiveData","ExternalAccessible"],"type":"string","description":"Represents the risks the system identifies on assets.","title":"Exposures"},"BusinessCriticality":{"enum":["Critical","High","Medium","Low"],"type":"string","description":"The operational importance of the asset."},"CreationType":{"enum":["Auto","Manual"],"type":"string","description":"Defines how the application asset is created."},"DataGovernance":{"enum":["PII","PCI","Financial","PHI","Sensitive"],"type":"string","description":"Type of data governance applied to the asset."},"Compliance":{"enum":["PCI-DSS","ISO 27001","SOX","NIST","GDPR","CCPA","HIPAA","FedRAMP"],"type":"string","description":"The compliance status or requirement category for an asset."},"ApplicationAssetSelection":{"type":"object","additionalProperties":false,"description":"Define the logic for how specific technical assets must be linked to this application.","required":["selectionType","section"],"properties":{"selectionType":{"$ref":"#/components/schemas/ApplicationAssetSelectionType"},"section":{"$ref":"#/components/schemas/ApplicationBuilderStartSection"},"filter":{"$ref":"#/components/schemas/ApplicationAssetSelectionFilter"},"assetIds":{"type":"array","description":"A list of unique identifiers representing the assets to be included.","items":{"type":"string"}}},"title":"Application Asset Selection"},"ApplicationAssetSelectionType":{"enum":["filter","assetIds"],"type":"string","description":"Method to select application assets."},"ApplicationBuilderStartSection":{"enum":["code","run"],"type":"string","description":"Identifies the functional section to which the asset selection applies."},"ApplicationAssetSelectionFilter":{"anyOf":[{"$ref":"#/components/schemas/ManualAndRunCriteriaApplicationAssetSelectionFilter"},{"$ref":"#/components/schemas/ApplicationAssetSelectionFilterValues"},{"type":"string"}],"description":"Defines filter criteria to dynamically select application assets. This field supports one of the supported application asset selection filter types.","title":"Application Asset Selection Filter"},"ManualAndRunCriteriaApplicationAssetSelectionFilter":{"additionalProperties":false,"type":"object","title":"Manual and Run Criteria Application Asset Selection Filter","required":["values","filterType"],"properties":{"values":{"type":"array","description":"If the filterType is `REPOSITORY`, enter the repository ID as the value. \nIf the filterType is `ORGANIZATION`, enter the organization URL of the provider.","items":{"type":"string"}},"provider":{"$ref":"#/components/schemas/Provider"},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"Provider":{"anyOf":[{"$ref":"#/components/schemas/BuildProvider"},{"$ref":"#/components/schemas/CodeProvider"},{"$ref":"#/components/schemas/RunProvider"},{"$ref":"#/components/schemas/DeployProvider"}]},"BuildProvider":{"enum":["CIRCLE_CI","JENKINS","GITLAB_CI","AZURE_PIPELINES","GITHUB_ACTIONS"],"type":"string","description":"Build system or CI provider used for the asset. **Allowed values:** `CIRCLE_CI` `JENKINS` `GITLAB_CI` `AZURE_PIPELINES` `GITHUB_ACTIONS`","title":"Build Provider"},"CodeProvider":{"enum":["GITLAB","GITHUB","BITBUCKET","AZURE_REPOS","AWS_CODE_COMMIT"],"type":"string","description":"Source code management (SCM) or code hosting provider.\n**Allowed values**: `GITLAB`, `GITHUB`, `BITBUCKET`, `AZURE_REPOS`, `AWS_CODE_COMMIT`","title":"Code Provider"},"RunProvider":{"enum":["GCP","AWS","AZURE"],"type":"string","description":"Runtime or execution environment provider for the application or asset. **Allowed Values**: `GCP`, `AWS`, `AZURE`","title":"Run Provider"},"DeployProvider":{"enum":["ACR","ECR","GAR","JFrog","Docker"],"type":"string","description":"Deployment platform or system used to deploy the application or asset. **Allowed values:** `ACR` `ECR` `GAR` `JFrog` `Docker`","title":"Deploy Provider"},"FilterType":{"anyOf":[{"$ref":"#/components/schemas/CodeFilterType"},{"$ref":"#/components/schemas/RunFilterType"}],"description":"The asset attribute used to filter assets from the selected provider."},"CodeFilterType":{"enum":["REPOSITORY","ORGANIZATION","CODE"],"type":"string","title":"Code Filter Type","description":"Specifies the available values for the code type filter."},"RunFilterType":{"enum":["K8S_NAMESPACE","K8S_CLUSTER","ORGANIZATION","RESOURCE_TAG","VPC","ACCOUNT"],"type":"string","title":"Run Type Filter","description":"Specifies the available values for the run type filter."},"ApplicationAssetSelectionFilterValues":{"type":"object","title":"Application Asset Selection Filter Values","description":"Defines the set of values used to evaluate the asset selection filter.","required":["values"],"properties":{"values":{"type":"object","description":"Container for filter values used to match application assets.","properties":{"orgUrl":{"type":"string","description":"Organization URL used to filter assets belonging to a specific organization."},"repositoryId":{"type":"string","description":"Unique identifier of the repository used to filter assets."},"projectUrl":{"type":"string","description":"Project URL used to filter assets belonging to a specific project."},"orgUnifyFilter":{"type":"object","description":"Defines unification rules applied at the organization level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the organization used for asset unification."}}},"projectUnifyFilter":{"type":"object","description":"Defines unification rules applied at the project level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the project used for asset unification."}}},"repositoryUnifyFilter":{"type":"object","description":"Defines unification rules applied at the repository level.","required":["providers","name"],"properties":{"providers":{"$ref":"#/components/schemas/Provider"},"name":{"type":"string","description":"Name of the repository used for asset unification."}}}}},"filterType":{"$ref":"#/components/schemas/FilterType"}}},"ApplicationEnrichStatus":{"enum":["IN_PROGRESS","NOT_IN_PROGRESS"],"type":"string","description":"Indicates whether asset enrichment is currently in progress."}}}}
```

## The UpdateApplicationRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UpdateApplicationRequest":{"type":"object","additionalProperties":false,"properties":{"businessCriticality":{"type":"string","enum":["Critical","High","Medium","Low"],"description":"The operational importance of the asset."},"creationType":{"type":"string","enum":["Auto","Manual"],"description":"How the asset was created."},"businessUnit":{"type":"string","description":"Business unit responsible for the asset."},"description":{"type":"string","description":"Description providing additional details about the asset."},"compliance":{"$ref":"#/components/schemas/Compliance"},"businessOwner":{"type":"array","description":"Business owners responsible for the asset.","items":{"type":"string"}},"devOwner":{"type":"array","description":"Development owners responsible for building and maintaining the asset.","items":{"type":"string"}},"devOpsOwner":{"type":"array","description":"DevOps owners responsible for deployment and operations.","items":{"type":"string"}},"productManager":{"type":"array","description":"Product managers responsible for the asset.","items":{"type":"string"}}}},"Compliance":{"enum":["PCI-DSS","ISO 27001","SOX","NIST","GDPR","CCPA","HIPAA","FedRAMP"],"type":"string","description":"The compliance status or requirement category for an asset."}}}}
```

## The Action object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Action":{"description":"Items Enum: 'blockCicd', 'blockPr', 'reportCicd', 'reportIssue', 'reportPrComment'","enum":["blockCicd","blockPr","reportCicd","reportIssue","reportPrComment"],"type":"string"}}}}
```

## The CIScansResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CIScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"integrationId":{"type":"string"},"scanId":{"type":"string"},"provider":{"type":"string"},"blockingPolicyName":{"type":"string"},"blockingPolicyId":{"type":"string"},"ciStatus":{"$ref":"#/components/schemas/ScanStatus"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"The timestamp of the last scan execution"},"branchName":{"type":"string","description":"The name of the branch analyzed during the scan"},"organizationName":{"type":"string","description":"Name of the organization owning the repository"},"repoName":{"type":"string","description":"Name of the scanned repository"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanStatus":{"enum":["ERROR","FAILED","IN_PROGRESS","PASSED","PASSED_WITH_ISSUES"],"type":"string","description":"Status of the PR scan. Valid values include:\n- `PASSED`\n- `PASSED_WITH_ISSUES`\n- `BLOCKED`\n- `IN_PROGRESS`\n- `ERROR`\n- `FAILED`"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"}}}}
```

## The CreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateRequest":{"type":"object","title":"CreateRequest","description":"Define the Application Security policy.\n\n**Notes:** \n- The `policyType` field is auto-assigned by the API based on the `Finding Type` in conditions, it is not set in the request body.\n- The `conditions` and `scope` fields are required. The `scope` can be set to `{}` for global scope.","additionalProperties":false,"required":["conditions","name","scope","triggers"],"properties":{"conditions":{"$ref":"#/components/schemas/PolicyCondition"},"description":{"type":"string","description":"A brief description of the AppSec policy's purpose."},"name":{"type":"string","description":"A unique name for the AppSec policy."},"scope":{"$ref":"#/components/schemas/PolicyScope"},"triggers":{"$ref":"#/components/schemas/AppsecPolicyTriggersandActions"},"enabled":{"type":"boolean","description":"Whether the policy is enabled upon creation."},"assetGroupIds":{"type":"array","description":"A list of asset group IDs that the policy should apply to. If the list is empty, the policy applies globally, unless other scope conditions are defined.\r\n**Note** : Cannot be used with the `scope` parameter.","items":{"type":"number","format":"double"}},"suggestionId":{"type":"string","description":"Unique identifier for the suggested policy to link this policy to."},"userSbac":{"type":"array","description":"Asset group IDs representing the user's scoped-based access control (SBAC) permissions at the time the policy is created. Controls which asset groups the policy applies to based on the creator's access. When empty, the policy applies to all user scoped asset groups.","items":{"type":"number","format":"double"}}}},"PolicyCondition":{"type":"object","title":"PolicyCondition","description":"Defines the specific criteria (conditions) that will trigger the policy. You can combine multiple conditions to create complex rules for when the policy should be applied. If you combine multiple `Finding Type` values using `OR`, only the common fields across those types will be valid.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Selecting `Finding Type` determines which condition fields you can configure. Each `Finding Type` supports a specific set of condition fields. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table.","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the condition filter should match. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."},"PolicyScope":{"type":"object","title":"PolicyScope","description":"Defines the type of assets to be evaluated by the policy (the scope). You can combine multiple conditions to create complex rules for when the policy should be applied.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Cannot be used if `assetGroupIds` are set.\n\nFor the list of available scope fields, see [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables).","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the matching criteria filter should match. To see which fields are allowed for each type, see the [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"AppsecPolicyTriggersandActions":{"title":"AppsecPolicyTriggersandActions","type":"object","description":"Defines when the AppSec policy should be evaluated. Configure triggers for periodic code scans, Pull Requests (PRs), CI Code scan, CI image scans, and Registry image scans. At least one trigger must have `isEnabled` set to `true`.","required":["cicd","ciImage","imageRegistry","periodic","pr"],"properties":{"cicd":{"type":"object","description":"Configuration for the CI Code  trigger. If `true`, the policy is evaluated on CI/CD pipeline events.","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI/CD pipeline."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI/CD pipeline in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Code Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"ciImage":{"type":"object","description":"Configuration for the CI image trigger. If `true`, the policy is evaluated during CI image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI image."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI image in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Image Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"imageRegistry":{"type":"object","description":"Configuration for the image registry trigger. If `true`, the policy is evaluated during registry image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the Registry Image Scan trigger is enabled."},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"periodic":{"type":"object","minProperties":1,"maxProperties":3,"description":"Configuration for the periodic code scan (scheduled) trigger. If `true`, the policy is evaluated.","required":["actions","isEnabled"],"properties":{"actions":{"type":"object","minProperties":1,"maxProperties":2,"description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the Periodic Scan trigger is enabled."},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"pr":{"type":"object","description":"Configuration for the pull request (PR) trigger. If `true`, the policy is evaluated on Pull Request (PR) events","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered. ","required":["blockPr","reportIssue","reportPrComment"],"properties":{"blockPr":{"type":"boolean","description":"Indicates if triggering the policy should block the pull request."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."},"reportPrComment":{"type":"boolean","description":"Indicates if triggering the policy should create comments on the pull request."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the PR Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}}}}}}}
```

## The DataSource object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"DataSource":{"enum":["GitHub","GitLab","Bitbucket","Azure Repos","Bitbucket Server","Bitbucket DataCenter","GitLab Dedicated","GitHub Enterprise","GitLab Self-Managed","Aws Code Commit"],"type":"string"}}}}
```

## The DetectionMethod object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"DetectionMethod":{"enum":["Secrets Security","Attack Path","Cve Security","Operational Risk Security","License Security","IaC Security","CIEM Scanner","API Traffic Monitor","API Posture Scanner","CLI Scanner","Agentless Disk Scanner","Kubernetes Scanner","Compute Policy","CSPM Scanner"],"type":"string"}}}}
```

## The FindingType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FindingType":{"enum":["CICD_RISKS","VULNERABILITY","SECRETS","IAC_MISCONFIGURATION","CODE_WEAKNESS","LICENSES","OPERATIONAL_RISK","MALWARE","DRIFT"],"type":"string"}}}}
```

## The Omit\_PackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Omit_PackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp_":{"$ref":"#/components/schemas/Pick_PackagesMetadataBq.Exclude_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp__"},"Pick_PackagesMetadataBq.Exclude_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp__":{"properties":{"packageName":{"type":"string"},"packageManager":{"type":"string"},"isDeprecated":{"type":"boolean"},"maintainersNumber":{"type":"number","format":"double"},"weeklyDownloads":{"type":"number","format":"double"},"openPrs":{"type":"number","format":"double"},"isArchived":{"type":"boolean"},"repoOwnerType":{"type":"string"},"contributorsNumber":{"type":"number","format":"double"},"repositoryUrl":{"type":"string"},"registryUrl":{"type":"string"},"latestVersionNumber":{"type":"string"},"numberOfVersions":{"type":"number","format":"double"},"stars":{"type":"number","format":"double"},"forks":{"type":"number","format":"double"},"openIssues":{"type":"number","format":"double"},"popularity":{"type":"string"},"maintenance":{"type":"string"},"operationalRisk":{"type":"string"}},"required":["packageName","packageManager"],"type":"object"}}}}
```

## The PackagesMetadataResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PackagesMetadataResponse":{"allOf":[{"$ref":"#/components/schemas/Omit_PackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp_"},{"properties":{"updatedTimestamp":{"type":"number","format":"double"},"firstVersionTimestamp":{"type":"number","format":"double"},"latestReleaseTimestamp":{"type":"number","format":"double"},"lastCommitTimestamp":{"type":"number","format":"double"}},"required":["updatedTimestamp"],"type":"object"}]},"Omit_PackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp_":{"$ref":"#/components/schemas/Pick_PackagesMetadataBq.Exclude_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp__"},"Pick_PackagesMetadataBq.Exclude_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp__":{"properties":{"packageName":{"type":"string"},"packageManager":{"type":"string"},"isDeprecated":{"type":"boolean"},"maintainersNumber":{"type":"number","format":"double"},"weeklyDownloads":{"type":"number","format":"double"},"openPrs":{"type":"number","format":"double"},"isArchived":{"type":"boolean"},"repoOwnerType":{"type":"string"},"contributorsNumber":{"type":"number","format":"double"},"repositoryUrl":{"type":"string"},"registryUrl":{"type":"string"},"latestVersionNumber":{"type":"string"},"numberOfVersions":{"type":"number","format":"double"},"stars":{"type":"number","format":"double"},"forks":{"type":"number","format":"double"},"openIssues":{"type":"number","format":"double"},"popularity":{"type":"string"},"maintenance":{"type":"string"},"operationalRisk":{"type":"string"}},"required":["packageName","packageManager"],"type":"object"}}}}
```

## The PeriodicScansResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PeriodicScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"integrationId":{"type":"string"},"provider":{"type":"string"},"scanId":{"type":"string","description":"Scan ID"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"Timestamp of the last scan execution"},"branchName":{"type":"string","description":"The branch analyzed during the scan"},"organizationName":{"type":"string","description":"The organization owning the repository"},"repoName":{"type":"string","description":"Name of the scanned repository"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"}}}}
```

## The Pick\_PackagesMetadataBq.Exclude\_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp\_\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Pick_PackagesMetadataBq.Exclude_keyofPackagesMetadataBq.lastCommitTimestamp-or-latestReleaseTimestamp-or-firstVersionTimestamp-or-updatedTimestamp__":{"properties":{"packageName":{"type":"string"},"packageManager":{"type":"string"},"isDeprecated":{"type":"boolean"},"maintainersNumber":{"type":"number","format":"double"},"weeklyDownloads":{"type":"number","format":"double"},"openPrs":{"type":"number","format":"double"},"isArchived":{"type":"boolean"},"repoOwnerType":{"type":"string"},"contributorsNumber":{"type":"number","format":"double"},"repositoryUrl":{"type":"string"},"registryUrl":{"type":"string"},"latestVersionNumber":{"type":"string"},"numberOfVersions":{"type":"number","format":"double"},"stars":{"type":"number","format":"double"},"forks":{"type":"number","format":"double"},"openIssues":{"type":"number","format":"double"},"popularity":{"type":"string"},"maintenance":{"type":"string"},"operationalRisk":{"type":"string"}},"required":["packageName","packageManager"],"type":"object"}}}}
```

## The Policy object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Policy":{"type":"object","additionalProperties":false,"required":["conditions","id","name","triggers","relatedDetectionRules","createdBy","isCustom","status","version"],"properties":{"dateCreated":{"type":"string","description":"The date and time when the policy was created"},"suggestionHash":{"type":"string","description":"Unique identifier for the suggested policy"},"conditions":{"$ref":"#/components/schemas/CortexCondition"},"description":{"type":"string","description":"Description of the policy"},"id":{"type":"string","description":"Unique identifier for the policy"},"name":{"type":"string","description":"Name of the policy"},"scope":{"$ref":"#/components/schemas/CortexCondition"},"triggers":{"$ref":"#/components/schemas/AppsecPolicyTriggersandActions"},"dateDeleted":{"type":"string","description":"The date and time when the policy was deleted"},"deletedBy":{"type":"string","description":"The user or system that deleted the policy"},"relatedDetectionRules":{"type":"array","description":"List of related detection rules","items":{"type":"string"}},"assetGroupIds":{"type":"array","description":"List of asset groups to which the policy applies. If the array is empty, the policy applies to all asset groups.","items":{"type":"number","format":"double"}},"suggestionId":{"type":"string","description":"Unique identifier for the suggested policy"},"createdBy":{"type":"string","description":"The user or system that created the policy"},"dateModified":{"type":"string","description":"The date and time when the policy was last modified"},"isClonable":{"type":"boolean","description":"Indicates if the policy is cloneable"},"isCustom":{"type":"boolean","description":"Indicates if the policy is a custom policy or a system-provided policy"},"isEditable":{"type":"boolean","description":"Indicates if the policy is editable"},"lastTriggered":{"type":"string","description":"The date and time when the policy was last triggered"},"modifiedBy":{"type":"string","description":"The user or system that last modified the policy"},"overrideIssueSeverity":{"description":"Set the severity of the issue and override the system severity. If not used, system severity is kept.","enum":["Critical","High","Medium","Low"]},"policyType":{"type":"string","description":"Indicates the policy type. Auto-assigned by the API based on the `Finding Type` in conditions. **Possible values**:\n- `code_image_scanners`: for VULNERABILITY, IAC_MISCONFIGURATION, SECRETS, CODE_WEAKNESS, LICENSES, OPERATIONAL_RISK, MALWARE\n- `cicd_configuration_scanners`: for CICD_RISKS\n- `drift_detection_scanners`: for DRIFT"},"scopeFields":{"type":"object","description":"Defines all valid scope fields grouped by category for code, CI/CD, drift, and common contexts.","required":["applicationsScopeFields","cicdOnlyScopeFields","codeOnlyScopeFields","commonScopeFields","defaultScopeFields","driftOnlyScopeFields"],"properties":{"applicationsScopeFields":{"description":"Fields that apply applications scopes.","type":"array","items":{"enum":["application_business_criticality","application_business_owner"]}},"cicdOnlyScopeFields":{"type":"array","description":"Fields that only apply to CI/CD related scope keys.","items":{"enum":["cicd_instance_id","cicd_instance_name","cicd_pipeline_id","cicd_pipeline_name","collaborator_email","collaborator_inactive_days","collaborator_mfa_enabled","collaborator_name","repository_organization","repository_organization_name"]}},"codeOnlyScopeFields":{"type":"array","description":"Fields that only apply to code repository scope keys.","items":{"enum":["has_access_sensitive_data","has_deployed_assets","has_internet_exposed","has_leverage_privileged_capabilities"]}},"commonScopeFields":{"type":"array","description":"Fields that apply to both code and CI/CD scopes.","items":{"enum":["business_application_names","category","is_public_repository","repository_id","repository_name","repository_provider","xdm__asset__tags"]}},"defaultScopeFields":{"type":"array","description":"Fields that comes as default in the finding.","items":{"enum":["xdm__asset__id","xdm__asset__name"]}},"driftOnlyScopeFields":{"type":"array","description":"Fields that only apply to IAC drift scope keys.","items":{"enum":["cloud_account","cloud_region"]}}}},"status":{"$ref":"#/components/schemas/PolicyStatus"},"version":{"type":"number","format":"double","description":"The version of the policy - goes up by one every policy update"}}},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."},"AppsecPolicyTriggersandActions":{"title":"AppsecPolicyTriggersandActions","type":"object","description":"Defines when the AppSec policy should be evaluated. Configure triggers for periodic code scans, Pull Requests (PRs), CI Code scan, CI image scans, and Registry image scans. At least one trigger must have `isEnabled` set to `true`.","required":["cicd","ciImage","imageRegistry","periodic","pr"],"properties":{"cicd":{"type":"object","description":"Configuration for the CI Code  trigger. If `true`, the policy is evaluated on CI/CD pipeline events.","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI/CD pipeline."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI/CD pipeline in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Code Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"ciImage":{"type":"object","description":"Configuration for the CI image trigger. If `true`, the policy is evaluated during CI image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI image."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI image in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Image Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"imageRegistry":{"type":"object","description":"Configuration for the image registry trigger. If `true`, the policy is evaluated during registry image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the Registry Image Scan trigger is enabled."},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"periodic":{"type":"object","minProperties":1,"maxProperties":3,"description":"Configuration for the periodic code scan (scheduled) trigger. If `true`, the policy is evaluated.","required":["actions","isEnabled"],"properties":{"actions":{"type":"object","minProperties":1,"maxProperties":2,"description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the Periodic Scan trigger is enabled."},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"pr":{"type":"object","description":"Configuration for the pull request (PR) trigger. If `true`, the policy is evaluated on Pull Request (PR) events","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered. ","required":["blockPr","reportIssue","reportPrComment"],"properties":{"blockPr":{"type":"boolean","description":"Indicates if triggering the policy should block the pull request."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."},"reportPrComment":{"type":"boolean","description":"Indicates if triggering the policy should create comments on the pull request."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the PR Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}}}},"PolicyStatus":{"description":"Indicates whether the policy is currently enabled or disabled.","enum":["disabled","enabled"],"type":"string","default":"enabled"}}}}
```

## The PolicyStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PolicyStatus":{"description":"Indicates whether the policy is currently enabled or disabled.","enum":["disabled","enabled"],"type":"string","default":"enabled"}}}}
```

## The PolicyTrigger object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PolicyTrigger":{"description":"Items Enum: 'cicd', 'pr', 'periodic'","enum":["cicd","pr","periodic"],"type":"string"}}}}
```

## The PolicyTriggers object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PolicyTriggers":{"type":"object","title":"PolicyTriggers","description":"Defines when the AppSec policy should be evaluated. At least one of the options must be `true`.","additionalProperties":false,"properties":{"periodic":{"type":"boolean","description":"If `true`, the AppSec policy is evaluated periodically (for example, daily or weekly)."},"pr":{"type":"boolean","description":"If `true`, the AppSec policy is evaluated on Pull Request (PR) events"},"cicd":{"type":"boolean","description":"If `true`, the Appsec policy is evaluated on CI/CD pipeline events."}}}}}}
```

## The PRScansResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PRScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"pullRequestTitle":{"type":"string"},"integrationId":{"type":"string"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"scanId":{"type":"string"},"provider":{"type":"string"},"userEmail":{"type":"string"},"blockingPolicyName":{"type":"string"},"blockingPolicyId":{"type":"string"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"The timestamp of the last scan execution"},"commitId":{"type":"string","description":"The commit included in the PR"},"pullRequestStatus":{"$ref":"#/components/schemas/ScanStatus"},"pullRequestId":{"type":"string","description":"The ID of the PR"},"branchName":{"type":"string","description":"Name of the branch analyzed during the scan"},"organizationName":{"type":"string","description":"Specifies the organizatio owning the repository"},"repoName":{"type":"string"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"},"ScanStatus":{"enum":["ERROR","FAILED","IN_PROGRESS","PASSED","PASSED_WITH_ISSUES"],"type":"string","description":"Status of the PR scan. Valid values include:\n- `PASSED`\n- `PASSED_WITH_ISSUES`\n- `BLOCKED`\n- `IN_PROGRESS`\n- `ERROR`\n- `FAILED`"}}}}
```

## The PublicScanRepositoryInput object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PublicScanRepositoryInput":{"properties":{"branchName":{"type":"string"}},"type":"object","additionalProperties":false,"title":""}}}}
```

## The Record\_string.number\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"}}}}
```

## The ResolutionReason object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ResolutionReason":{"enum":["Resolved - Known Issue","Resolved - Duplicate Incident","Resolved - False Positive","Resolved - Other","Resolved - True Positive","Resolved - Security Testing","Resolved - Dismissed","Resolved - Fixed","Resolved - Auto Resolve","Resolved - Threat Handled"],"type":"string"}}}}
```

## The ResolutionStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ResolutionStatus":{"enum":["New","Under Investigation","Resolved"],"type":"string"}}}}
```

## The ScanFailureResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanFailureResponse":{"properties":{"err_msg":{"type":"string"},"metadata":{"properties":{},"additionalProperties":{},"type":"object"}},"required":["err_msg","metadata"],"type":"object","additionalProperties":false}}}}
```

## The ScanFindingsResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanFindingsResponse":{"properties":{"scan_source":{"$ref":"#/components/schemas/ScanType"},"git_user":{"type":"string"},"first_hash_time":{"type":"string"},"first_hash":{"type":"string"},"platform_id":{"type":"string"},"branch":{"type":"string"},"detection_method":{"$ref":"#/components/schemas/DetectionMethod"},"file_path":{"type":"string"},"description":{"type":"string"},"last_observed":{"type":"string"},"first_observed":{"type":"string"},"suppression_type":{"$ref":"#/components/schemas/SuppressionType"},"data_source":{"$ref":"#/components/schemas/DataSource"},"name":{"type":"string"},"category":{"type":"string"},"asset_id":{"type":"string"},"asset_name":{"type":"string"},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"scan_id":{"type":"string"},"issue_name":{"type":"string"}},"required":["scan_source","git_user","first_hash_time","first_hash","platform_id","branch","detection_method","file_path","description","last_observed","first_observed","suppression_type","data_source","name","category","asset_id","asset_name","severity","scan_id","issue_name"],"type":"object"},"ScanType":{"enum":["pr","cicd","periodic"],"type":"string"},"DetectionMethod":{"enum":["Secrets Security","Attack Path","Cve Security","Operational Risk Security","License Security","IaC Security","CIEM Scanner","API Traffic Monitor","API Posture Scanner","CLI Scanner","Agentless Disk Scanner","Kubernetes Scanner","Compute Policy","CSPM Scanner"],"type":"string"},"SuppressionType":{"enum":["Inline"],"type":"string"},"DataSource":{"enum":["GitHub","GitLab","Bitbucket","Azure Repos","Bitbucket Server","Bitbucket DataCenter","GitLab Dedicated","GitHub Enterprise","GitLab Self-Managed","Aws Code Commit"],"type":"string"},"SeverityEnum":{"enum":["Critical","High","Medium","Low"],"type":"string"}}}}
```

## The ScanHealthEnum object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"}}}}
```

## The ScanIssuesResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanIssuesResponse":{"properties":{"resolution_comment":{"type":"string"},"resolution_reason":{"$ref":"#/components/schemas/ResolutionReason"},"resolution_status":{"$ref":"#/components/schemas/ResolutionStatus"},"assignee":{"type":"string"},"branch":{"type":"string"},"run_id":{"type":"string"},"pull_request_id":{"type":"string"},"repo_id":{"type":"string"},"created":{"type":"string"},"file_path":{"type":"string"},"asset_name":{"type":"string"},"detection_method":{"$ref":"#/components/schemas/DetectionMethod"},"alert_name":{"type":"string"},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"scan_id":{"type":"string"},"issue_id":{"type":"string"}},"required":["resolution_comment","resolution_reason","resolution_status","assignee","branch","run_id","pull_request_id","repo_id","created","file_path","asset_name","detection_method","alert_name","severity","scan_id","issue_id"],"type":"object"},"ResolutionReason":{"enum":["Resolved - Known Issue","Resolved - Duplicate Incident","Resolved - False Positive","Resolved - Other","Resolved - True Positive","Resolved - Security Testing","Resolved - Dismissed","Resolved - Fixed","Resolved - Auto Resolve","Resolved - Threat Handled"],"type":"string"},"ResolutionStatus":{"enum":["New","Under Investigation","Resolved"],"type":"string"},"DetectionMethod":{"enum":["Secrets Security","Attack Path","Cve Security","Operational Risk Security","License Security","IaC Security","CIEM Scanner","API Traffic Monitor","API Posture Scanner","CLI Scanner","Agentless Disk Scanner","Kubernetes Scanner","Compute Policy","CSPM Scanner"],"type":"string"},"SeverityEnum":{"enum":["Critical","High","Medium","Low"],"type":"string"}}}}
```

## The ScanRepositorySuccessResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanRepositorySuccessResponse":{"properties":{"metadata":{"properties":{"scan_id":{"type":"string"}},"required":["scan_id"],"type":"object"}},"required":["metadata"],"type":"object","additionalProperties":false}}}}
```

## The ScanStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanStatus":{"enum":["ERROR","FAILED","IN_PROGRESS","PASSED","PASSED_WITH_ISSUES"],"type":"string","description":"Status of the PR scan. Valid values include:\n- `PASSED`\n- `PASSED_WITH_ISSUES`\n- `BLOCKED`\n- `IN_PROGRESS`\n- `ERROR`\n- `FAILED`"}}}}
```

## The ScanType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanType":{"enum":["pr","cicd","periodic"],"type":"string"}}}}
```

## The SeverityEnum object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SeverityEnum":{"enum":["Critical","High","Medium","Low"],"type":"string"}}}}
```

## The SuppressionType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SuppressionType":{"enum":["Inline"],"type":"string"}}}}
```

## The UpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UpdateRequest":{"$ref":"#/components/schemas/Partial_BasePolicyRequest","description":"Edit the Application Security policy"},"Partial_BasePolicyRequest":{"type":"object","required":["conditions","scope"],"properties":{"name":{"type":"string","description":"A unique name for the AppSec policy."},"description":{"type":"string","description":"A brief description of the AppSec policy's purpose."},"conditions":{"$ref":"#/components/schemas/PolicyCondition"},"scope":{"$ref":"#/components/schemas/PolicyScope"},"triggers":{"$ref":"#/components/schemas/AppsecPolicyTriggersandActions"},"relatedDetectionRules":{"type":"array","description":"List of related detection rules.","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Whether the policy is enabled."},"suggestionId":{"type":"string","description":"Unique identifier for the suggested policy."},"assetGroupIds":{"type":"array","description":"List of asset groups to which the policy applies. If the array is empty, the policy applies to all asset groups.","items":{"type":"number","format":"double"}},"userSbac":{"type":"array","description":"Asset group IDs representing the user's scoped-based access control (SBAC) permissions at the time the policy is modified. Controls which asset groups the policy applies to based on the modifier's access. When empty, the policy applies to all asset groups.","items":{"type":"number","format":"double"}}}},"PolicyCondition":{"type":"object","title":"PolicyCondition","description":"Defines the specific criteria (conditions) that will trigger the policy. You can combine multiple conditions to create complex rules for when the policy should be applied. If you combine multiple `Finding Type` values using `OR`, only the common fields across those types will be valid.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Selecting `Finding Type` determines which condition fields you can configure. Each `Finding Type` supports a specific set of condition fields. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table.","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the condition filter should match. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."},"PolicyScope":{"type":"object","title":"PolicyScope","description":"Defines the type of assets to be evaluated by the policy (the scope). You can combine multiple conditions to create complex rules for when the policy should be applied.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Cannot be used if `assetGroupIds` are set.\n\nFor the list of available scope fields, see [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables).","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the matching criteria filter should match. To see which fields are allowed for each type, see the [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"AppsecPolicyTriggersandActions":{"title":"AppsecPolicyTriggersandActions","type":"object","description":"Defines when the AppSec policy should be evaluated. Configure triggers for periodic code scans, Pull Requests (PRs), CI Code scan, CI image scans, and Registry image scans. At least one trigger must have `isEnabled` set to `true`.","required":["cicd","ciImage","imageRegistry","periodic","pr"],"properties":{"cicd":{"type":"object","description":"Configuration for the CI Code  trigger. If `true`, the policy is evaluated on CI/CD pipeline events.","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI/CD pipeline."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI/CD pipeline in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Code Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"ciImage":{"type":"object","description":"Configuration for the CI image trigger. If `true`, the policy is evaluated during CI image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI image."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI image in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Image Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"imageRegistry":{"type":"object","description":"Configuration for the image registry trigger. If `true`, the policy is evaluated during registry image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the Registry Image Scan trigger is enabled."},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"periodic":{"type":"object","minProperties":1,"maxProperties":3,"description":"Configuration for the periodic code scan (scheduled) trigger. If `true`, the policy is evaluated.","required":["actions","isEnabled"],"properties":{"actions":{"type":"object","minProperties":1,"maxProperties":2,"description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the Periodic Scan trigger is enabled."},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"pr":{"type":"object","description":"Configuration for the pull request (PR) trigger. If `true`, the policy is evaluated on Pull Request (PR) events","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered. ","required":["blockPr","reportIssue","reportPrComment"],"properties":{"blockPr":{"type":"boolean","description":"Indicates if triggering the policy should block the pull request."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."},"reportPrComment":{"type":"boolean","description":"Indicates if triggering the policy should create comments on the pull request."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the PR Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}}}}}}}
```

## The ValidateCustomRuleRequestParams object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ValidateCustomRuleRequestParams":{"properties":{"framework":{"$ref":"#/components/schemas/FrameworkName"},"definition":{"type":"string"}},"required":["framework","definition"],"type":"object","additionalProperties":false},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The CortexCondition object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."}}}}
```

## The ConditionOperators object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."}}}}
```

## The Scanner object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Scanner":{"type":"string","enum":["CICD","IAC","SCA","SECRETS"],"description":"The scanner type used by this rule to detect security issues."}}}}
```

## The Severity object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Severity":{"type":"string","enum":["CRITICAL","HIGH","LOW","MEDIUM"],"title":"Severity","description":"Severity level of the rule"}}}}
```

## The FrameworkName object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The SortDirection object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SortDirection":{"type":"integer","enum":[-1,1]}}}}
```

## The GetRulesResponseObject object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"GetRulesResponseObject":{"type":"object","title":"GetRulesResponseObject","properties":{"offset":{"type":"number","description":"The starting position of the current page of results."},"nextOffset":{"type":"number","description":"The offset to use in the next request to retrieve the next page of results. Returns `null` if there are no more results.","nullable":true},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DetectionRule"}}}},"DetectionRule":{"type":"object","title":"DetectionRule","description":"Details of the Application Security rule","properties":{"category":{"type":"string","description":"Custom Appsec rule category."},"cloudProvider":{"$ref":"#/components/schemas/CloudProvider"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was created."},"description":{"type":"string","description":"The rule description."},"shortDescription":{"type":"string","description":"A brief summary of the rule. If not provided, this field is null.","nullable":true},"detectionMethod":{"type":"string","description":"Security scanner used to detect findings for this rule."},"docLink":{"type":"string","description":"A URL linking to the relevant Cortex Cloud documentation page."},"domain":{"type":"string","description":"The domain associated with the rule."},"findingCategory":{"$ref":"#/components/schemas/FindingCategory"},"findingDocs":{"type":"string"},"findingTypeId":{"type":"number","format":"double","description":"The numeric identifier of the finding type associated with this rule. "},"findingTypeName":{"type":"string","description":"Display name of the finding type associated with this rule. Matches the rule `name` for custom rules."},"frameworks":{"type":"array","items":{"$ref":"#/components/schemas/Frameworks"}},"id":{"type":"string","description":"Unique identifier of the AppSec rule."},"isCustom":{"type":"boolean","description":"Indicates whether the rule is a custom rule created by the user (true) or an out-of-the-box rule (false)."},"isEnabled":{"type":"boolean","description":"Indicates whether the rule is currently active and will generate findings during scans."},"labels":{"type":"array","description":"Labels assigned to the rule.","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was last modified."},"mitreTactics":{"type":"array","description":"The MITRE ATT&CK tactic identifiers associated with this rule. Returns an empty array if no tactics are mapped.","nullable":true,"items":{"type":"string"}},"mitreTechniques":{"type":"array","description":"The MITRE ATT&CK technique identifiers associated with this rule. Returns an empty array if no techniques are mapped.","nullable":true,"items":{"type":"string"}},"name":{"type":"string","description":"Name of the Appsec rule."},"owner":{"type":"string","description":"The internal service owner of the rule."},"scanner":{"$ref":"#/components/schemas/Scanner"},"severity":{"$ref":"#/components/schemas/Severity"},"subCategory":{"type":"string","description":"Custom rule subcategory."},"complianceStandards":{"$ref":"#/components/schemas/ComplianceStandard"},"cspmRuleId":{"type":"string","description":"The ID of the mapped Cloud Security rule. When set, findings from this AppSec rule are correlated with the corresponding Cloud Security rule. Returns `null` if no rule is mapped.","nullable":true},"cspmTypeId":{"type":"number","description":"The numeric type identifier of the mapped Cloud Security rule. Returned only when the AppSec rule is linked to a rule via `cspmRuleId`.","nullable":true}}},"CloudProvider":{"type":"string","enum":["ALIBABA_CLOUD","AWS","Azure","GCP","IBM","ORACLE","OTHER"],"description":"The cloud provider associated with the rule. If the rule is not cloud-provider-specific, this field is null."},"FindingCategory":{"type":"string","enum":["Code","Configuration","Data","Vulnerability"],"description":"Category of findings this rule generates."},"Frameworks":{"type":"object","properties":{"frameworkDetails":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/FrameworkDetails"}]}},"description":"Framework objects containing the rule definition and remediation details for each supported IaC framework or secrets detection framework. "},"FrameworkDetails":{"type":"object","properties":{"definition":{"type":"string","description":"The rule definition.","nullable":true},"definition_link":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"name":{"$ref":"#/components/schemas/FrameworkName"},"remediation_description":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.","nullable":true},"remediation_ids":{"type":"array","description":"The IDs of related remediation resources.","nullable":true,"items":{"type":"string"}},"resource_types":{"type":"array","description":"The resource types associated with the rule.","nullable":true,"items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."},"Scanner":{"type":"string","enum":["CICD","IAC","SCA","SECRETS"],"description":"The scanner type used by this rule to detect security issues."},"Severity":{"type":"string","enum":["CRITICAL","HIGH","LOW","MEDIUM"],"title":"Severity","description":"Severity level of the rule"},"ComplianceStandard":{"type":"object","additionalProperties":false,"description":"An array of compliance standards associated with this rule.","properties":{"standardName":{"type":"string","description":"The name of the compliance framework or standard that this rule is mapped to. "},"controls":{"type":"array","items":{"$ref":"#/components/schemas/Control"}}}},"Control":{"type":"object","additionalProperties":false,"description":"An array of individual controls within the compliance standard that this rule satisfies. ","required":["controlName","controlDefinition"],"properties":{"controlName":{"type":"string","description":"The name or identifier of the compliance control."},"controlDefinition":{"type":"string","description":"A description of what the compliance control requires or validates. "}}}}}}
```

## The Control object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Control":{"type":"object","additionalProperties":false,"description":"An array of individual controls within the compliance standard that this rule satisfies. ","required":["controlName","controlDefinition"],"properties":{"controlName":{"type":"string","description":"The name or identifier of the compliance control."},"controlDefinition":{"type":"string","description":"A description of what the compliance control requires or validates. "}}}}}}
```

## The ComplianceStandard object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ComplianceStandard":{"type":"object","additionalProperties":false,"description":"An array of compliance standards associated with this rule.","properties":{"standardName":{"type":"string","description":"The name of the compliance framework or standard that this rule is mapped to. "},"controls":{"type":"array","items":{"$ref":"#/components/schemas/Control"}}}},"Control":{"type":"object","additionalProperties":false,"description":"An array of individual controls within the compliance standard that this rule satisfies. ","required":["controlName","controlDefinition"],"properties":{"controlName":{"type":"string","description":"The name or identifier of the compliance control."},"controlDefinition":{"type":"string","description":"A description of what the compliance control requires or validates. "}}}}}}
```

## The DetectionRule object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"DetectionRule":{"type":"object","title":"DetectionRule","description":"Details of the Application Security rule","properties":{"category":{"type":"string","description":"Custom Appsec rule category."},"cloudProvider":{"$ref":"#/components/schemas/CloudProvider"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was created."},"description":{"type":"string","description":"The rule description."},"shortDescription":{"type":"string","description":"A brief summary of the rule. If not provided, this field is null.","nullable":true},"detectionMethod":{"type":"string","description":"Security scanner used to detect findings for this rule."},"docLink":{"type":"string","description":"A URL linking to the relevant Cortex Cloud documentation page."},"domain":{"type":"string","description":"The domain associated with the rule."},"findingCategory":{"$ref":"#/components/schemas/FindingCategory"},"findingDocs":{"type":"string"},"findingTypeId":{"type":"number","format":"double","description":"The numeric identifier of the finding type associated with this rule. "},"findingTypeName":{"type":"string","description":"Display name of the finding type associated with this rule. Matches the rule `name` for custom rules."},"frameworks":{"type":"array","items":{"$ref":"#/components/schemas/Frameworks"}},"id":{"type":"string","description":"Unique identifier of the AppSec rule."},"isCustom":{"type":"boolean","description":"Indicates whether the rule is a custom rule created by the user (true) or an out-of-the-box rule (false)."},"isEnabled":{"type":"boolean","description":"Indicates whether the rule is currently active and will generate findings during scans."},"labels":{"type":"array","description":"Labels assigned to the rule.","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was last modified."},"mitreTactics":{"type":"array","description":"The MITRE ATT&CK tactic identifiers associated with this rule. Returns an empty array if no tactics are mapped.","nullable":true,"items":{"type":"string"}},"mitreTechniques":{"type":"array","description":"The MITRE ATT&CK technique identifiers associated with this rule. Returns an empty array if no techniques are mapped.","nullable":true,"items":{"type":"string"}},"name":{"type":"string","description":"Name of the Appsec rule."},"owner":{"type":"string","description":"The internal service owner of the rule."},"scanner":{"$ref":"#/components/schemas/Scanner"},"severity":{"$ref":"#/components/schemas/Severity"},"subCategory":{"type":"string","description":"Custom rule subcategory."},"complianceStandards":{"$ref":"#/components/schemas/ComplianceStandard"},"cspmRuleId":{"type":"string","description":"The ID of the mapped Cloud Security rule. When set, findings from this AppSec rule are correlated with the corresponding Cloud Security rule. Returns `null` if no rule is mapped.","nullable":true},"cspmTypeId":{"type":"number","description":"The numeric type identifier of the mapped Cloud Security rule. Returned only when the AppSec rule is linked to a rule via `cspmRuleId`.","nullable":true}}},"CloudProvider":{"type":"string","enum":["ALIBABA_CLOUD","AWS","Azure","GCP","IBM","ORACLE","OTHER"],"description":"The cloud provider associated with the rule. If the rule is not cloud-provider-specific, this field is null."},"FindingCategory":{"type":"string","enum":["Code","Configuration","Data","Vulnerability"],"description":"Category of findings this rule generates."},"Frameworks":{"type":"object","properties":{"frameworkDetails":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/FrameworkDetails"}]}},"description":"Framework objects containing the rule definition and remediation details for each supported IaC framework or secrets detection framework. "},"FrameworkDetails":{"type":"object","properties":{"definition":{"type":"string","description":"The rule definition.","nullable":true},"definition_link":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"name":{"$ref":"#/components/schemas/FrameworkName"},"remediation_description":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.","nullable":true},"remediation_ids":{"type":"array","description":"The IDs of related remediation resources.","nullable":true,"items":{"type":"string"}},"resource_types":{"type":"array","description":"The resource types associated with the rule.","nullable":true,"items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."},"Scanner":{"type":"string","enum":["CICD","IAC","SCA","SECRETS"],"description":"The scanner type used by this rule to detect security issues."},"Severity":{"type":"string","enum":["CRITICAL","HIGH","LOW","MEDIUM"],"title":"Severity","description":"Severity level of the rule"},"ComplianceStandard":{"type":"object","additionalProperties":false,"description":"An array of compliance standards associated with this rule.","properties":{"standardName":{"type":"string","description":"The name of the compliance framework or standard that this rule is mapped to. "},"controls":{"type":"array","items":{"$ref":"#/components/schemas/Control"}}}},"Control":{"type":"object","additionalProperties":false,"description":"An array of individual controls within the compliance standard that this rule satisfies. ","required":["controlName","controlDefinition"],"properties":{"controlName":{"type":"string","description":"The name or identifier of the compliance control."},"controlDefinition":{"type":"string","description":"A description of what the compliance control requires or validates. "}}}}}}
```

## The CloudProvider object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CloudProvider":{"type":"string","enum":["ALIBABA_CLOUD","AWS","Azure","GCP","IBM","ORACLE","OTHER"],"description":"The cloud provider associated with the rule. If the rule is not cloud-provider-specific, this field is null."}}}}
```

## The FindingCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FindingCategory":{"type":"string","enum":["Code","Configuration","Data","Vulnerability"],"description":"Category of findings this rule generates."}}}}
```

## The Frameworks object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Frameworks":{"type":"object","properties":{"frameworkDetails":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/FrameworkDetails"}]}},"description":"Framework objects containing the rule definition and remediation details for each supported IaC framework or secrets detection framework. "},"FrameworkDetails":{"type":"object","properties":{"definition":{"type":"string","description":"The rule definition.","nullable":true},"definition_link":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"name":{"$ref":"#/components/schemas/FrameworkName"},"remediation_description":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.","nullable":true},"remediation_ids":{"type":"array","description":"The IDs of related remediation resources.","nullable":true,"items":{"type":"string"}},"resource_types":{"type":"array","description":"The resource types associated with the rule.","nullable":true,"items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The FrameworkDetails object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FrameworkDetails":{"type":"object","properties":{"definition":{"type":"string","description":"The rule definition.","nullable":true},"definition_link":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"name":{"$ref":"#/components/schemas/FrameworkName"},"remediation_description":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.","nullable":true},"remediation_ids":{"type":"array","description":"The IDs of related remediation resources.","nullable":true,"items":{"type":"string"}},"resource_types":{"type":"array","description":"The resource types associated with the rule.","nullable":true,"items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The CreateOrModifyCustomRuleRequestParams object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateOrModifyCustomRuleRequestParams":{"type":"object","title":"CreateOrModifyCustomRuleRequestParams","description":"Define the Application Security custom rule. The `category` option should match your selection for `scanner`.","additionalProperties":false,"required":["name","severity","scanner","frameworks","category","subCategory"],"properties":{"name":{"type":"string","description":"A unique name for the Appsec rule."},"description":{"type":"string","description":"Description of the rule"},"severity":{"$ref":"#/components/schemas/Severity"},"labels":{"type":"array","description":"Labels to be assigned to the rule","items":{"type":"string"}},"scanner":{"$ref":"#/components/schemas/CustomRuleScanner"},"frameworks":{"$ref":"#/components/schemas/FrameworkRequestParams"},"category":{"anyOf":[{"$ref":"#/components/schemas/CustomRuleIacCategory"},{"$ref":"#/components/schemas/CustomRuleSecretsCategory"}]},"subCategory":{"$ref":"#/components/schemas/CustomRuleIacSubCategory"},"cspmRuleId":{"type":"string","description":"The unique identifier of the Cloud Security rule to which the custom Application Security rule will be mapped. Applicable only when `scanner` is set to `IAC`.","nullable":true},"clonedFromRuleId":{"type":"string","description":"Optional. ID of the source rule from which this rule was cloned. This field is present only for cloned rules.","nullable":true}}},"Severity":{"type":"string","enum":["CRITICAL","HIGH","LOW","MEDIUM"],"title":"Severity","description":"Severity level of the rule"},"CustomRuleScanner":{"title":"CustomRuleScanner","description":"The type of security scanner used to detect findings of this rule. Choose any one of the scanners.","enum":["IAC","SECRETS"],"type":"string"},"FrameworkRequestParams":{"type":"object","title":"FrameworkRequestParams","additionalProperties":false,"required":["name","definition"],"properties":{"name":{"$ref":"#/components/schemas/FrameworkName"},"definition":{"type":"string","description":"The rule definition\n\nIaC example:\n`definition:\\n cond_type: attribute\\n resource_types:\\n - aws_s3_bucket_public_access_block\\n attribute: block_public_acls\\n operator: equals\\n value: false`\n\nSecrets example:\n`definition:\\n cond_type: secrets\\n value: AIza[0-9A-Za-z-_]{35}`\n","nullable":true},"definitionLink":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"remediationDescription":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.\n\nIaC Example: Set block_public_acls to true in aws_s3_bucket_public_access_block resource\n\nSecrets Example: Revoke the GCP API key immediately through the Google Cloud Console.","nullable":true}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."},"CustomRuleIacCategory":{"type":"string","enum":["AI_ML","COMPUTE","IAM","KUBERNETES","LOGGING","MONITORING","NETWORKING","PUBLIC","STORAGE"],"title":"CustomRuleIacCategory","description":"Custom rule IaC category. Applicable only when `scanner` is set to `IAC`."},"CustomRuleSecretsCategory":{"type":"string","enum":["API_KEYS","DATABASE_CREDENTIALS","ENCRYPTION_KEYS","CLOUD_SERVICE_PROVIDER_KEYS","SSH_KEYS","ENVIRONMENT_VARIABLES","SENSITIVE_TOKENS","THIRD_PARTY_SERVICES"],"title":"CustomRuleSecretsCategory","description":"Custom rule secret category. Applicable only when `scanner` is set to `SECRETS`."},"CustomRuleIacSubCategory":{"type":"string","enum":["GUARDRAILS","RISKY_MODELS","PUBLIC_EXPOSURE","PERMISSIONS","ENCRYPTION","RETENTION","FORMATS","DISABLED_OR_MISSING","UNDER_USE","NETWORK_POLICIES","ACCESS_CONTROL","LOGGING_AND_MONITORING","RESOURCE_MANAGEMENT","NATIVE_SECURITY_CONTROLS","MANAGEMENT_SERVICES_EXPOSURE","OVERPROVISIONED","STARTUP_SCRIPT_LEAKS","DEFAULT_CREDENTIALS_OR_AUTH","UNSANCTIONED_RESOURCE_OR_TYPE","BACKUPS","VERSIONING","REPLICATION","ALERTING","REDUNDANCY","ADMIN_INTERFACES","DATABASE_ENDPOINTS","STORAGE_BUCKETS","APIS","SENSITIVE_PORTS","LOAD_BALANCING","INGRESS_CONTROLS","EGRESS_CONTROLS","ENCRYPTION_AND_PROTOCOLS","VPC_VCN_VNET","FLOW_LOGS","TAGS_AND_METADATA","RESOURCE_HEALTH","PERFORMANCE_MONITORING","ALERTING_AND_NOTIFICATIONS","UNINTEGRATED","STORAGE","OVERLY_PERMISSIVE","UNUSED","CREDENTIAL_EXPOSURE","MFA","ROLE_SEPARATION","SHARED","EXPIRED_KEY_CONTROLS","AUTHENTICATION_POLICIES"],"title":"CustomRuleIacSubCategory","description":"Custom rule subcategory. The supported values depend on the selected category. Refer to the following table for the valid subcategories for each category.\n\nNote: This field is applicable only when `scanner` is set to `IAC`.\n\n## Category and Subcategory Table for IaC Scanner\n\n| Category | Subcategory |\n|----------|-------------|\n| AI and Machine Learning (`AI_ML`) | Guardrails (`GUARDRAILS`) |\n| AI and Machine Learning (`AI_ML`) | Risky models (`RISKY_MODELS`) |\n| AI and Machine Learning (`AI_ML`) | Public Exposure (`PUBLIC_EXPOSURE`) |\n| AI and Machine Learning (`AI_ML`) | Permissions (`PERMISSIONS`) |\n| Logging (`LOGGING`) | Encryption (`ENCRYPTION`) |\n| Logging (`LOGGING`) | Permissions (`PERMISSIONS`) |\n| Logging (`LOGGING`) | Retention (`RETENTION`) |\n| Logging (`LOGGING`) | Formats (`FORMATS`) |\n| Logging (`LOGGING`) | Disabled or missing (`DISABLED_OR_MISSING`) |\n| Logging (`LOGGING`) | Public Exposure (`PUBLIC_EXPOSURE`) |\n| Logging (`LOGGING`) | Under Use (`UNDER_USE`) |\n| Kubernetes (`KUBERNETES`) | Network Policies (`NETWORK_POLICIES`) |\n| Kubernetes (`KUBERNETES`) | Access Control (`ACCESS_CONTROL`) |\n| Kubernetes (`KUBERNETES`) | Logging and Monitoring (`LOGGING_AND_MONITORING`) |\n| Kubernetes (`KUBERNETES`) | Resource Management (`RESOURCE_MANAGEMENT`) |\n| Kubernetes (`KUBERNETES`) | Native Security Controls (`NATIVE_SECURITY_CONTROLS`) |\n| Kubernetes (`KUBERNETES`) | Management Services Exposure (`MANAGEMENT_SERVICES_EXPOSURE`) |\n| Compute (`COMPUTE`) | Overprovisioned (`OVERPROVISIONED`) |\n| Compute (`COMPUTE`) | Startup Script Leaks (`STARTUP_SCRIPT_LEAKS`) |\n| Compute (`COMPUTE`) | Default Credentials or Auth (`DEFAULT_CREDENTIALS_OR_AUTH`) |\n| Compute (`COMPUTE`) | Unsanctioned Resource or Type (`UNSANCTIONED_RESOURCE_OR_TYPE`) |\n| Storage (`STORAGE`) | Encryption (`ENCRYPTION`) |\n| Storage (`STORAGE`) | Permissions (`PERMISSIONS`) |\n| Storage (`STORAGE`) | Backups (`BACKUPS`) |\n| Storage (`STORAGE`) | Versioning (`VERSIONING`) |\n| Storage (`STORAGE`) | Replication (`REPLICATION`) |\n| Storage (`STORAGE`) | Alerting (`ALERTING`) |\n| Storage (`STORAGE`) | Redundancy (`REDUNDANCY`) |\n| Public (`PUBLIC`) | Admin Interfaces (`ADMIN_INTERFACES`) |\n| Public (`PUBLIC`) | Database Endpoints (`DATABASE_ENDPOINTS`) |\n| Public (`PUBLIC`) | Storage Buckets (`STORAGE_BUCKETS`) |\n| Public (`PUBLIC`) | APIs (`APIS`) |\n| Public (`PUBLIC`) | Sensitive Ports (`SENSITIVE_PORTS`) |\n| Networking (`NETWORKING`) | Load Balancing (`LOAD_BALANCING`) |\n| Networking (`NETWORKING`) | Ingress Controls (`INGRESS_CONTROLS`) |\n| Networking (`NETWORKING`) | Egress Controls (`EGRESS_CONTROLS`) |\n| Networking (`NETWORKING`) | Encryption and Protocols (`ENCRYPTION_AND_PROTOCOLS`) |\n| Networking (`NETWORKING`) | VPC/VCN/VNET (`VPC_VCN_VNET`) |\n| Networking (`NETWORKING`) | Flow Logs (`FLOW_LOGS`) |\n| Monitoring (`MONITORING`) | Tags and metadata (`TAGS_AND_METADATA`) |\n| Monitoring (`MONITORING`) | Resource Health (`RESOURCE_HEALTH`) |\n| Monitoring (`MONITORING`) | Performance Monitoring (`PERFORMANCE_MONITORING`) |\n| Monitoring (`MONITORING`) | Alerting and Notifications (`ALERTING_AND_NOTIFICATIONS`) |\n| Monitoring (`MONITORING`) | Unintegrated (`UNINTEGRATED`) |\n| Monitoring (`MONITORING`) | Storage (`STORAGE`) |\n| IAM (`IAM`) | Overly Permissive (`OVERLY_PERMISSIVE`) |\n| IAM (`IAM`) | Unused (`UNUSED`) |\n| IAM (`IAM`) | Credential Exposure (`CREDENTIAL_EXPOSURE`) |\n| IAM (`IAM`) | MFA (`MFA`) |\n| IAM (`IAM`) | Role Separation (`ROLE_SEPARATION`) |\n| IAM (`IAM`) | Shared (`SHARED`) |\n| IAM (`IAM`) | Expired Key Controls (`EXPIRED_KEY_CONTROLS`) |\n| IAM (`IAM`) | Authentication Policies (`AUTHENTICATION_POLICIES`) |"}}}}
```

## The CustomRuleScanner object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CustomRuleScanner":{"title":"CustomRuleScanner","description":"The type of security scanner used to detect findings of this rule. Choose any one of the scanners.","enum":["IAC","SECRETS"],"type":"string"}}}}
```

## The FrameworkRequestParams object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FrameworkRequestParams":{"type":"object","title":"FrameworkRequestParams","additionalProperties":false,"required":["name","definition"],"properties":{"name":{"$ref":"#/components/schemas/FrameworkName"},"definition":{"type":"string","description":"The rule definition\n\nIaC example:\n`definition:\\n cond_type: attribute\\n resource_types:\\n - aws_s3_bucket_public_access_block\\n attribute: block_public_acls\\n operator: equals\\n value: false`\n\nSecrets example:\n`definition:\\n cond_type: secrets\\n value: AIza[0-9A-Za-z-_]{35}`\n","nullable":true},"definitionLink":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"remediationDescription":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.\n\nIaC Example: Set block_public_acls to true in aws_s3_bucket_public_access_block resource\n\nSecrets Example: Revoke the GCP API key immediately through the Google Cloud Console.","nullable":true}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The CustomRuleCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CustomRuleCategory":{"anyOf":[{"$ref":"#/components/schemas/CustomRuleIacCategory"},{"$ref":"#/components/schemas/CustomRuleSecretsCategory"}]},"CustomRuleIacCategory":{"type":"string","enum":["AI_ML","COMPUTE","IAM","KUBERNETES","LOGGING","MONITORING","NETWORKING","PUBLIC","STORAGE"],"title":"CustomRuleIacCategory","description":"Custom rule IaC category. Applicable only when `scanner` is set to `IAC`."},"CustomRuleSecretsCategory":{"type":"string","enum":["API_KEYS","DATABASE_CREDENTIALS","ENCRYPTION_KEYS","CLOUD_SERVICE_PROVIDER_KEYS","SSH_KEYS","ENVIRONMENT_VARIABLES","SENSITIVE_TOKENS","THIRD_PARTY_SERVICES"],"title":"CustomRuleSecretsCategory","description":"Custom rule secret category. Applicable only when `scanner` is set to `SECRETS`."}}}}
```

## The CustomRuleIacCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CustomRuleIacCategory":{"type":"string","enum":["AI_ML","COMPUTE","IAM","KUBERNETES","LOGGING","MONITORING","NETWORKING","PUBLIC","STORAGE"],"title":"CustomRuleIacCategory","description":"Custom rule IaC category. Applicable only when `scanner` is set to `IAC`."}}}}
```

## The CustomRuleSecretsCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CustomRuleSecretsCategory":{"type":"string","enum":["API_KEYS","DATABASE_CREDENTIALS","ENCRYPTION_KEYS","CLOUD_SERVICE_PROVIDER_KEYS","SSH_KEYS","ENVIRONMENT_VARIABLES","SENSITIVE_TOKENS","THIRD_PARTY_SERVICES"],"title":"CustomRuleSecretsCategory","description":"Custom rule secret category. Applicable only when `scanner` is set to `SECRETS`."}}}}
```

## The CustomRuleIacSubCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CustomRuleIacSubCategory":{"type":"string","enum":["GUARDRAILS","RISKY_MODELS","PUBLIC_EXPOSURE","PERMISSIONS","ENCRYPTION","RETENTION","FORMATS","DISABLED_OR_MISSING","UNDER_USE","NETWORK_POLICIES","ACCESS_CONTROL","LOGGING_AND_MONITORING","RESOURCE_MANAGEMENT","NATIVE_SECURITY_CONTROLS","MANAGEMENT_SERVICES_EXPOSURE","OVERPROVISIONED","STARTUP_SCRIPT_LEAKS","DEFAULT_CREDENTIALS_OR_AUTH","UNSANCTIONED_RESOURCE_OR_TYPE","BACKUPS","VERSIONING","REPLICATION","ALERTING","REDUNDANCY","ADMIN_INTERFACES","DATABASE_ENDPOINTS","STORAGE_BUCKETS","APIS","SENSITIVE_PORTS","LOAD_BALANCING","INGRESS_CONTROLS","EGRESS_CONTROLS","ENCRYPTION_AND_PROTOCOLS","VPC_VCN_VNET","FLOW_LOGS","TAGS_AND_METADATA","RESOURCE_HEALTH","PERFORMANCE_MONITORING","ALERTING_AND_NOTIFICATIONS","UNINTEGRATED","STORAGE","OVERLY_PERMISSIVE","UNUSED","CREDENTIAL_EXPOSURE","MFA","ROLE_SEPARATION","SHARED","EXPIRED_KEY_CONTROLS","AUTHENTICATION_POLICIES"],"title":"CustomRuleIacSubCategory","description":"Custom rule subcategory. The supported values depend on the selected category. Refer to the following table for the valid subcategories for each category.\n\nNote: This field is applicable only when `scanner` is set to `IAC`.\n\n## Category and Subcategory Table for IaC Scanner\n\n| Category | Subcategory |\n|----------|-------------|\n| AI and Machine Learning (`AI_ML`) | Guardrails (`GUARDRAILS`) |\n| AI and Machine Learning (`AI_ML`) | Risky models (`RISKY_MODELS`) |\n| AI and Machine Learning (`AI_ML`) | Public Exposure (`PUBLIC_EXPOSURE`) |\n| AI and Machine Learning (`AI_ML`) | Permissions (`PERMISSIONS`) |\n| Logging (`LOGGING`) | Encryption (`ENCRYPTION`) |\n| Logging (`LOGGING`) | Permissions (`PERMISSIONS`) |\n| Logging (`LOGGING`) | Retention (`RETENTION`) |\n| Logging (`LOGGING`) | Formats (`FORMATS`) |\n| Logging (`LOGGING`) | Disabled or missing (`DISABLED_OR_MISSING`) |\n| Logging (`LOGGING`) | Public Exposure (`PUBLIC_EXPOSURE`) |\n| Logging (`LOGGING`) | Under Use (`UNDER_USE`) |\n| Kubernetes (`KUBERNETES`) | Network Policies (`NETWORK_POLICIES`) |\n| Kubernetes (`KUBERNETES`) | Access Control (`ACCESS_CONTROL`) |\n| Kubernetes (`KUBERNETES`) | Logging and Monitoring (`LOGGING_AND_MONITORING`) |\n| Kubernetes (`KUBERNETES`) | Resource Management (`RESOURCE_MANAGEMENT`) |\n| Kubernetes (`KUBERNETES`) | Native Security Controls (`NATIVE_SECURITY_CONTROLS`) |\n| Kubernetes (`KUBERNETES`) | Management Services Exposure (`MANAGEMENT_SERVICES_EXPOSURE`) |\n| Compute (`COMPUTE`) | Overprovisioned (`OVERPROVISIONED`) |\n| Compute (`COMPUTE`) | Startup Script Leaks (`STARTUP_SCRIPT_LEAKS`) |\n| Compute (`COMPUTE`) | Default Credentials or Auth (`DEFAULT_CREDENTIALS_OR_AUTH`) |\n| Compute (`COMPUTE`) | Unsanctioned Resource or Type (`UNSANCTIONED_RESOURCE_OR_TYPE`) |\n| Storage (`STORAGE`) | Encryption (`ENCRYPTION`) |\n| Storage (`STORAGE`) | Permissions (`PERMISSIONS`) |\n| Storage (`STORAGE`) | Backups (`BACKUPS`) |\n| Storage (`STORAGE`) | Versioning (`VERSIONING`) |\n| Storage (`STORAGE`) | Replication (`REPLICATION`) |\n| Storage (`STORAGE`) | Alerting (`ALERTING`) |\n| Storage (`STORAGE`) | Redundancy (`REDUNDANCY`) |\n| Public (`PUBLIC`) | Admin Interfaces (`ADMIN_INTERFACES`) |\n| Public (`PUBLIC`) | Database Endpoints (`DATABASE_ENDPOINTS`) |\n| Public (`PUBLIC`) | Storage Buckets (`STORAGE_BUCKETS`) |\n| Public (`PUBLIC`) | APIs (`APIS`) |\n| Public (`PUBLIC`) | Sensitive Ports (`SENSITIVE_PORTS`) |\n| Networking (`NETWORKING`) | Load Balancing (`LOAD_BALANCING`) |\n| Networking (`NETWORKING`) | Ingress Controls (`INGRESS_CONTROLS`) |\n| Networking (`NETWORKING`) | Egress Controls (`EGRESS_CONTROLS`) |\n| Networking (`NETWORKING`) | Encryption and Protocols (`ENCRYPTION_AND_PROTOCOLS`) |\n| Networking (`NETWORKING`) | VPC/VCN/VNET (`VPC_VCN_VNET`) |\n| Networking (`NETWORKING`) | Flow Logs (`FLOW_LOGS`) |\n| Monitoring (`MONITORING`) | Tags and metadata (`TAGS_AND_METADATA`) |\n| Monitoring (`MONITORING`) | Resource Health (`RESOURCE_HEALTH`) |\n| Monitoring (`MONITORING`) | Performance Monitoring (`PERFORMANCE_MONITORING`) |\n| Monitoring (`MONITORING`) | Alerting and Notifications (`ALERTING_AND_NOTIFICATIONS`) |\n| Monitoring (`MONITORING`) | Unintegrated (`UNINTEGRATED`) |\n| Monitoring (`MONITORING`) | Storage (`STORAGE`) |\n| IAM (`IAM`) | Overly Permissive (`OVERLY_PERMISSIVE`) |\n| IAM (`IAM`) | Unused (`UNUSED`) |\n| IAM (`IAM`) | Credential Exposure (`CREDENTIAL_EXPOSURE`) |\n| IAM (`IAM`) | MFA (`MFA`) |\n| IAM (`IAM`) | Role Separation (`ROLE_SEPARATION`) |\n| IAM (`IAM`) | Shared (`SHARED`) |\n| IAM (`IAM`) | Expired Key Controls (`EXPIRED_KEY_CONTROLS`) |\n| IAM (`IAM`) | Authentication Policies (`AUTHENTICATION_POLICIES`) |"}}}}
```

## The FrameworkErrorsResponseData object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"FrameworkErrorsResponseData":{"type":"object","title":"FrameworkErrorsResponseData","additionalProperties":false,"properties":{"framework":{"$ref":"#/components/schemas/FrameworkName"},"errors":{"type":"array","items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The ModifyRuleParams object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ModifyRuleParams":{"type":"object","title":"ModifyRuleParams","additionalProperties":false,"properties":{"labels":{"type":"array","description":"List of rule labels","items":{"type":"string"}}},"required":["labels"]}}}}
```

## The ModifyRuleResponseObject object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ModifyRuleResponseObject":{"type":"object","title":"ModifyRuleResponseObject","description":"Updated details of the modified Application Security rule","properties":{"rule":{"$ref":"#/components/schemas/DetectionRule"}}},"DetectionRule":{"type":"object","title":"DetectionRule","description":"Details of the Application Security rule","properties":{"category":{"type":"string","description":"Custom Appsec rule category."},"cloudProvider":{"$ref":"#/components/schemas/CloudProvider"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was created."},"description":{"type":"string","description":"The rule description."},"shortDescription":{"type":"string","description":"A brief summary of the rule. If not provided, this field is null.","nullable":true},"detectionMethod":{"type":"string","description":"Security scanner used to detect findings for this rule."},"docLink":{"type":"string","description":"A URL linking to the relevant Cortex Cloud documentation page."},"domain":{"type":"string","description":"The domain associated with the rule."},"findingCategory":{"$ref":"#/components/schemas/FindingCategory"},"findingDocs":{"type":"string"},"findingTypeId":{"type":"number","format":"double","description":"The numeric identifier of the finding type associated with this rule. "},"findingTypeName":{"type":"string","description":"Display name of the finding type associated with this rule. Matches the rule `name` for custom rules."},"frameworks":{"type":"array","items":{"$ref":"#/components/schemas/Frameworks"}},"id":{"type":"string","description":"Unique identifier of the AppSec rule."},"isCustom":{"type":"boolean","description":"Indicates whether the rule is a custom rule created by the user (true) or an out-of-the-box rule (false)."},"isEnabled":{"type":"boolean","description":"Indicates whether the rule is currently active and will generate findings during scans."},"labels":{"type":"array","description":"Labels assigned to the rule.","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the AppSec rule was last modified."},"mitreTactics":{"type":"array","description":"The MITRE ATT&CK tactic identifiers associated with this rule. Returns an empty array if no tactics are mapped.","nullable":true,"items":{"type":"string"}},"mitreTechniques":{"type":"array","description":"The MITRE ATT&CK technique identifiers associated with this rule. Returns an empty array if no techniques are mapped.","nullable":true,"items":{"type":"string"}},"name":{"type":"string","description":"Name of the Appsec rule."},"owner":{"type":"string","description":"The internal service owner of the rule."},"scanner":{"$ref":"#/components/schemas/Scanner"},"severity":{"$ref":"#/components/schemas/Severity"},"subCategory":{"type":"string","description":"Custom rule subcategory."},"complianceStandards":{"$ref":"#/components/schemas/ComplianceStandard"},"cspmRuleId":{"type":"string","description":"The ID of the mapped Cloud Security rule. When set, findings from this AppSec rule are correlated with the corresponding Cloud Security rule. Returns `null` if no rule is mapped.","nullable":true},"cspmTypeId":{"type":"number","description":"The numeric type identifier of the mapped Cloud Security rule. Returned only when the AppSec rule is linked to a rule via `cspmRuleId`.","nullable":true}}},"CloudProvider":{"type":"string","enum":["ALIBABA_CLOUD","AWS","Azure","GCP","IBM","ORACLE","OTHER"],"description":"The cloud provider associated with the rule. If the rule is not cloud-provider-specific, this field is null."},"FindingCategory":{"type":"string","enum":["Code","Configuration","Data","Vulnerability"],"description":"Category of findings this rule generates."},"Frameworks":{"type":"object","properties":{"frameworkDetails":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/FrameworkDetails"}]}},"description":"Framework objects containing the rule definition and remediation details for each supported IaC framework or secrets detection framework. "},"FrameworkDetails":{"type":"object","properties":{"definition":{"type":"string","description":"The rule definition.","nullable":true},"definition_link":{"type":"string","description":"**http** link to the definition documentation.","nullable":true},"name":{"$ref":"#/components/schemas/FrameworkName"},"remediation_description":{"type":"string","description":"The remediation steps that will appear on the Appsec rule's findings.","nullable":true},"remediation_ids":{"type":"array","description":"The IDs of related remediation resources.","nullable":true,"items":{"type":"string"}},"resource_types":{"type":"array","description":"The resource types associated with the rule.","nullable":true,"items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."},"Scanner":{"type":"string","enum":["CICD","IAC","SCA","SECRETS"],"description":"The scanner type used by this rule to detect security issues."},"Severity":{"type":"string","enum":["CRITICAL","HIGH","LOW","MEDIUM"],"title":"Severity","description":"Severity level of the rule"},"ComplianceStandard":{"type":"object","additionalProperties":false,"description":"An array of compliance standards associated with this rule.","properties":{"standardName":{"type":"string","description":"The name of the compliance framework or standard that this rule is mapped to. "},"controls":{"type":"array","items":{"$ref":"#/components/schemas/Control"}}}},"Control":{"type":"object","additionalProperties":false,"description":"An array of individual controls within the compliance standard that this rule satisfies. ","required":["controlName","controlDefinition"],"properties":{"controlName":{"type":"string","description":"The name or identifier of the compliance control."},"controlDefinition":{"type":"string","description":"A description of what the compliance control requires or validates. "}}}}}}
```

## The GetLabelsResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"GetLabelsResponse":{"type":"object","title":"GetLabelsResponse","description":"A list of labels","additionalProperties":false,"properties":{"labels":{"type":"array","items":{"type":"string"}}}}}}}
```

## The ValidateCodeResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ValidateCodeResponse":{"anyOf":[{"properties":{"frameworksErrors":{"type":"array","items":{"$ref":"#/components/schemas/FrameworkErrorsResponseData"}}}},{"properties":{"isValid":{"type":"boolean"}}}],"type":"object"},"FrameworkErrorsResponseData":{"type":"object","title":"FrameworkErrorsResponseData","additionalProperties":false,"properties":{"framework":{"$ref":"#/components/schemas/FrameworkName"},"errors":{"type":"array","items":{"type":"string"}}}},"FrameworkName":{"type":"string","enum":["ARM","BICEP","CLOUDFORMATION","KUBERNETES","TERRAFORM"],"title":"FrameworkName","description":"Name of the configured Infrastructure as Code (IaC) framework for this rule definition. **Note:** Applicable only when `scanner` is set to `IAC`."}}}}
```

## The IntegrationType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "}}}}
```

## The Omit\_Repository.assetId\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Omit_Repository.assetId_":{"$ref":"#/components/schemas/Pick_Repository.Exclude_keyofRepository.assetId__"},"Pick_Repository.Exclude_keyofRepository.assetId__":{"type":"object","title":"RepositoryResponse","properties":{"name":{"type":"string","description":"The name of the repository in the version control system (VCS)"},"description":{"type":"string","description":"Description describing the repository"},"creationDate":{"type":"string"},"defaultBranch":{"type":"string"},"diskSize":{"type":"number","format":"double"},"externalId":{"type":"string"},"id":{"type":"string","description":"Repository ID"},"integrationId":{"type":"string"},"isArchived":{"type":"boolean","description":"Whether the repository is archived"},"isBillable":{"type":"boolean","description":"Whether the repository is billable"},"isForked":{"type":"boolean","description":"Whether the repository is forked"},"isPublic":{"type":"boolean","description":"Whether the repository is public"},"isSelected":{"type":"boolean","description":"Whether the repository is selected"},"lastScanDate":{"type":"string"},"observationTime":{"type":"number","format":"double","description":"The date the repository was last updated"},"organizationId":{"type":"string"},"owner":{"type":"string","description":"Repository owner"},"projectId":{"type":"string"},"scanConfiguration":{"$ref":"#/components/schemas/ScanConfiguration"},"scannedBranch":{"type":"string"},"scannedBranches":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}},"source":{"$ref":"#/components/schemas/IntegrationType"},"status":{"$ref":"#/components/schemas/RepositoryStatus"},"url":{"type":"string","description":"URL of the repository"}}},"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]},"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "},"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The Pick\_Repository.Exclude\_keyofRepository.assetId\_\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Pick_Repository.Exclude_keyofRepository.assetId__":{"type":"object","title":"RepositoryResponse","properties":{"name":{"type":"string","description":"The name of the repository in the version control system (VCS)"},"description":{"type":"string","description":"Description describing the repository"},"creationDate":{"type":"string"},"defaultBranch":{"type":"string"},"diskSize":{"type":"number","format":"double"},"externalId":{"type":"string"},"id":{"type":"string","description":"Repository ID"},"integrationId":{"type":"string"},"isArchived":{"type":"boolean","description":"Whether the repository is archived"},"isBillable":{"type":"boolean","description":"Whether the repository is billable"},"isForked":{"type":"boolean","description":"Whether the repository is forked"},"isPublic":{"type":"boolean","description":"Whether the repository is public"},"isSelected":{"type":"boolean","description":"Whether the repository is selected"},"lastScanDate":{"type":"string"},"observationTime":{"type":"number","format":"double","description":"The date the repository was last updated"},"organizationId":{"type":"string"},"owner":{"type":"string","description":"Repository owner"},"projectId":{"type":"string"},"scanConfiguration":{"$ref":"#/components/schemas/ScanConfiguration"},"scannedBranch":{"type":"string"},"scannedBranches":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}},"source":{"$ref":"#/components/schemas/IntegrationType"},"status":{"$ref":"#/components/schemas/RepositoryStatus"},"url":{"type":"string","description":"URL of the repository"}}},"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]},"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "},"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The ScanConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]}}}}
```

## The PRScanning object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]}}}}
```

## The ScannerTypes object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]}}}}
```

## The ScannerConfig object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]}}}}
```

## The TaggingBot object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]}}}}
```

## The Branch object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}}}}}
```

## The RepositoryStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The RepositoryStatusDetails object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The StatusValue object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The UpdateScanConfigurationPublicInput object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UpdateScanConfigurationPublicInput":{"type":"object","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"},"scanners":{"type":"object","properties":{"SECRETS":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"scanOptions":{"$ref":"#/components/schemas/Partial_any_"}}},"SCA":{"$ref":"#/components/schemas/Omit_ScannerConfig.scanOptions_"},"IAC":{"$ref":"#/components/schemas/Omit_ScannerConfig.scanOptions_"}}}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]},"Partial_any_":{"type":"object","description":"Make all properties in T optional","properties":{"gitHistory":{"type":"boolean"},"secretValidation":{"type":"boolean"}}},"Omit_ScannerConfig.scanOptions_":{"$ref":"#/components/schemas/Pick_ScannerConfig.Exclude_keyofScannerConfig.scanOptions__"},"Pick_ScannerConfig.Exclude_keyofScannerConfig.scanOptions__":{"type":"object","description":"From T, pick a set of properties whose keys are in the union K","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/RepositoryStatus"},"creationDate":{"type":"string"},"defaultBranch":{"type":"string"},"diskSize":{"type":"number","format":"double"},"externalId":{"type":"string"},"id":{"type":"string"},"integrationId":{"type":"string"},"isArchived":{"type":"boolean"},"isBillable":{"type":"boolean"},"isForked":{"type":"boolean"},"isPublic":{"type":"boolean"},"isSelected":{"type":"boolean"},"lastScanDate":{"type":"string"},"observationTime":{"type":"number","format":"double"},"organizationId":{"type":"string"},"owner":{"type":"string"},"projectId":{"type":"string"},"scanConfiguration":{"$ref":"#/components/schemas/ScanConfiguration"},"scannedBranch":{"type":"string"},"scannedBranches":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}},"source":{"$ref":"#/components/schemas/IntegrationType"},"url":{"type":"string"}},"required":["name","description","status","creationDate","defaultBranch","externalId","id","integrationId","isArchived","isBillable","isForked","isPublic","isSelected","organizationId","owner","scannedBranch","source","url"]},"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]},"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "}}}}
```

## The Omit\_ScannerConfig.scanOptions\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Omit_ScannerConfig.scanOptions_":{"$ref":"#/components/schemas/Pick_ScannerConfig.Exclude_keyofScannerConfig.scanOptions__"},"Pick_ScannerConfig.Exclude_keyofScannerConfig.scanOptions__":{"type":"object","description":"From T, pick a set of properties whose keys are in the union K","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/RepositoryStatus"},"creationDate":{"type":"string"},"defaultBranch":{"type":"string"},"diskSize":{"type":"number","format":"double"},"externalId":{"type":"string"},"id":{"type":"string"},"integrationId":{"type":"string"},"isArchived":{"type":"boolean"},"isBillable":{"type":"boolean"},"isForked":{"type":"boolean"},"isPublic":{"type":"boolean"},"isSelected":{"type":"boolean"},"lastScanDate":{"type":"string"},"observationTime":{"type":"number","format":"double"},"organizationId":{"type":"string"},"owner":{"type":"string"},"projectId":{"type":"string"},"scanConfiguration":{"$ref":"#/components/schemas/ScanConfiguration"},"scannedBranch":{"type":"string"},"scannedBranches":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}},"source":{"$ref":"#/components/schemas/IntegrationType"},"url":{"type":"string"}},"required":["name","description","status","creationDate","defaultBranch","externalId","id","integrationId","isArchived","isBillable","isForked","isPublic","isSelected","organizationId","owner","scannedBranch","source","url"]},"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]},"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]},"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "}}}}
```

## The Pick\_ScannerConfig.Exclude\_keyofScannerConfig.scanOptions\_\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Pick_ScannerConfig.Exclude_keyofScannerConfig.scanOptions__":{"type":"object","description":"From T, pick a set of properties whose keys are in the union K","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/RepositoryStatus"},"creationDate":{"type":"string"},"defaultBranch":{"type":"string"},"diskSize":{"type":"number","format":"double"},"externalId":{"type":"string"},"id":{"type":"string"},"integrationId":{"type":"string"},"isArchived":{"type":"boolean"},"isBillable":{"type":"boolean"},"isForked":{"type":"boolean"},"isPublic":{"type":"boolean"},"isSelected":{"type":"boolean"},"lastScanDate":{"type":"string"},"observationTime":{"type":"number","format":"double"},"organizationId":{"type":"string"},"owner":{"type":"string"},"projectId":{"type":"string"},"scanConfiguration":{"$ref":"#/components/schemas/ScanConfiguration"},"scannedBranch":{"type":"string"},"scannedBranches":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}},"source":{"$ref":"#/components/schemas/IntegrationType"},"url":{"type":"string"}},"required":["name","description","status","creationDate","defaultBranch","externalId","id","integrationId","isArchived","isBillable","isForked","isPublic","isSelected","organizationId","owner","scannedBranch","source","url"]},"RepositoryStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"properties":{"apiRead":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"apiWrite":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"clone":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"connection":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"webhookSubscription":{"$ref":"#/components/schemas/RepositoryStatusDetails"},"token":{"$ref":"#/components/schemas/RepositoryStatusDetails"}},"required":["apiRead","apiWrite","clone","connection","webhookSubscription","token"]},"RepositoryStatusDetails":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusValue"}},"required":["status"]},"StatusValue":{"type":"string","enum":["INVALID","VALID"]},"ScanConfiguration":{"type":"object","title":"ScanConfiguration","description":"The configuration of an Application Security code scanner","additionalProperties":false,"properties":{"excludedPaths":{"type":"array","items":{"type":"string"}},"prScanning":{"$ref":"#/components/schemas/PRScanning"},"scanners":{"$ref":"#/components/schemas/ScannerTypes"},"taggingBot":{"$ref":"#/components/schemas/TaggingBot"}}},"PRScanning":{"type":"object","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. The scan results are based on default enforcement thresholds.","additionalProperties":false,"properties":{"blockOnError":{"type":"boolean"},"isEnabled":{"type":"boolean","description":"Indicates whether the PR scan is enabled"}},"required":["blockOnError","isEnabled"]},"ScannerTypes":{"type":"object","title":"ScannerTypes","description":"Details on each type of scanner: Branch periodic scans, CI scans, IaC scans, Secrets scans","additionalProperties":false,"properties":{"GIT_HISTORY":{"$ref":"#/components/schemas/ScannerConfig"},"IAC":{"$ref":"#/components/schemas/ScannerConfig"},"SCA":{"$ref":"#/components/schemas/ScannerConfig"},"SECRETS":{"$ref":"#/components/schemas/ScannerConfig"}},"required":["GIT_HISTORY","IAC","SCA","SECRETS"]},"ScannerConfig":{"type":"object","title":"ScannerConfig","description":"Scanner configuration","additionalProperties":false,"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scanner is enabled"},"scanOptions":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["isEnabled"]},"TaggingBot":{"type":"object","additionalProperties":false,"properties":{"tagModuleBlocks":{"type":"boolean"},"tagResourceBlocks":{"type":"boolean"}},"required":["tagModuleBlocks","tagResourceBlocks"]},"Branch":{"type":"object","additionalProperties":false,"properties":{"diskSize":{"type":"number","format":"double"},"firstScanDate":{"type":"string","description":"Timestamp of the first scan performed"},"id":{"type":"string","description":"Branch ID"},"isPrimary":{"type":"boolean","description":"Indicates whether or not the branch is the primary branch"},"lastApiCallDate":{"type":"string"},"lastCloneDate":{"type":"string"},"lastCloneSha":{"type":"string"},"lastScanDate":{"type":"string","description":"Timestamp of the last scan execution"},"name":{"type":"string","description":"Branch name"},"repositoryId":{"type":"string","description":"Repository ID"}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "}}}}
```

## The Partial\_any\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Partial_any_":{"type":"object","description":"Make all properties in T optional","properties":{"gitHistory":{"type":"boolean"},"secretValidation":{"type":"boolean"}}}}}}
```

## The SetPersistBranchesApi object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SetPersistBranchesApi":{"type":"object","additionalProperties":false,"properties":{"selectedBranches":{"type":"array","items":{"type":"string"}},"primaryBranch":{"type":"string"}},"required":["selectedBranches","primaryBranch"]}}}}
```

## The Partial\_BasePolicyRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Partial_BasePolicyRequest":{"type":"object","required":["conditions","scope"],"properties":{"name":{"type":"string","description":"A unique name for the AppSec policy."},"description":{"type":"string","description":"A brief description of the AppSec policy's purpose."},"conditions":{"$ref":"#/components/schemas/PolicyCondition"},"scope":{"$ref":"#/components/schemas/PolicyScope"},"triggers":{"$ref":"#/components/schemas/AppsecPolicyTriggersandActions"},"relatedDetectionRules":{"type":"array","description":"List of related detection rules.","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Whether the policy is enabled."},"suggestionId":{"type":"string","description":"Unique identifier for the suggested policy."},"assetGroupIds":{"type":"array","description":"List of asset groups to which the policy applies. If the array is empty, the policy applies to all asset groups.","items":{"type":"number","format":"double"}},"userSbac":{"type":"array","description":"Asset group IDs representing the user's scoped-based access control (SBAC) permissions at the time the policy is modified. Controls which asset groups the policy applies to based on the modifier's access. When empty, the policy applies to all asset groups.","items":{"type":"number","format":"double"}}}},"PolicyCondition":{"type":"object","title":"PolicyCondition","description":"Defines the specific criteria (conditions) that will trigger the policy. You can combine multiple conditions to create complex rules for when the policy should be applied. If you combine multiple `Finding Type` values using `OR`, only the common fields across those types will be valid.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Selecting `Finding Type` determines which condition fields you can configure. Each `Finding Type` supports a specific set of condition fields. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table.","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the condition filter should match. To see which fields are allowed for each type, see the [Supported Condition Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionOperators":{"type":"string","enum":["ARRAY_CONTAINS","ARRAY_NOT_CONTAINS","CONTAINS","CONTAINS_IN_LIST","EQ","GT","GTE","IN","JSON_WILDCARD","JSON_WILDCARD_NOT","LTE","LT","NCONTAINS","NEQ","NIN","NOT_CONTAINS_IN_LIST","RANGE","RELATIVE_TIMESTAMP","WILDCARD","WILDCARD_NOT","withinGracePeriod"],"title":"ConditionOperators","description":"Condition operator for this filter."},"CortexCondition":{"type":"object","title":"CortexCondition","description":"Condition or scope filter for the policy. ","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Field the condition filter matches."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"The value compared against. The type of this field will differ depending on the `SEARCH_FIELD` that was specified.","anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ConditionValue"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."},"PolicyScope":{"type":"object","title":"PolicyScope","description":"Defines the type of assets to be evaluated by the policy (the scope). You can combine multiple conditions to create complex rules for when the policy should be applied.\n\n**Note:** \n* When used in `AND`, all conditions within this array must be met. \n* When used in `OR`, at least one condition within this array must be met.\n* Cannot be used if `assetGroupIds` are set.\n\nFor the list of available scope fields, see [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables).","additionalProperties":false,"required":["SEARCH_FIELD","SEARCH_TYPE","SEARCH_VALUE"],"properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the field the matching criteria filter should match. To see which fields are allowed for each type, see the [Supported Scope Fields](https://app.gitbook.com/s/1ZrobAtcwfCDWAJAWeuj/aspm-cicd-and-application-security/appsec-papi-tables) table."},"SEARCH_TYPE":{"$ref":"#/components/schemas/ConditionOperators"},"SEARCH_VALUE":{"description":"Value that the condition filter must match. The type of this field will differ depending on the `SEARCH_FIELD` that you specified.","anyOf":[{"type":"boolean"},{"type":"number","format":"double"},{"type":"string"}]},"AND":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}},"OR":{"type":"array","items":{"$ref":"#/components/schemas/CortexCondition"}}}},"AppsecPolicyTriggersandActions":{"title":"AppsecPolicyTriggersandActions","type":"object","description":"Defines when the AppSec policy should be evaluated. Configure triggers for periodic code scans, Pull Requests (PRs), CI Code scan, CI image scans, and Registry image scans. At least one trigger must have `isEnabled` set to `true`.","required":["cicd","ciImage","imageRegistry","periodic","pr"],"properties":{"cicd":{"type":"object","description":"Configuration for the CI Code  trigger. If `true`, the policy is evaluated on CI/CD pipeline events.","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI/CD pipeline."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI/CD pipeline in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Code Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"ciImage":{"type":"object","description":"Configuration for the CI image trigger. If `true`, the policy is evaluated during CI image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI image."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI image in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Image Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"imageRegistry":{"type":"object","description":"Configuration for the image registry trigger. If `true`, the policy is evaluated during registry image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the Registry Image Scan trigger is enabled."},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"periodic":{"type":"object","minProperties":1,"maxProperties":3,"description":"Configuration for the periodic code scan (scheduled) trigger. If `true`, the policy is evaluated.","required":["actions","isEnabled"],"properties":{"actions":{"type":"object","minProperties":1,"maxProperties":2,"description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the Periodic Scan trigger is enabled."},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"pr":{"type":"object","description":"Configuration for the pull request (PR) trigger. If `true`, the policy is evaluated on Pull Request (PR) events","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered. ","required":["blockPr","reportIssue","reportPrComment"],"properties":{"blockPr":{"type":"boolean","description":"Indicates if triggering the policy should block the pull request."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."},"reportPrComment":{"type":"boolean","description":"Indicates if triggering the policy should create comments on the pull request."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the PR Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}}}}}}}
```

## The BasicScanInfo object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BasicScanInfo":{"type":"object","properties":{"organizationId":{"type":"string","description":"Organization ID"},"repoName":{"type":"string","description":"Name of the repository"},"repoId":{"type":"string","description":"ID of the repository"}}}}}}
```

## The AppsecPolicyTriggersandActions object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"AppsecPolicyTriggersandActions":{"title":"AppsecPolicyTriggersandActions","type":"object","description":"Defines when the AppSec policy should be evaluated. Configure triggers for periodic code scans, Pull Requests (PRs), CI Code scan, CI image scans, and Registry image scans. At least one trigger must have `isEnabled` set to `true`.","required":["cicd","ciImage","imageRegistry","periodic","pr"],"properties":{"cicd":{"type":"object","description":"Configuration for the CI Code  trigger. If `true`, the policy is evaluated on CI/CD pipeline events.","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI/CD pipeline."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI/CD pipeline in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Code Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"ciImage":{"type":"object","description":"Configuration for the CI image trigger. If `true`, the policy is evaluated during CI image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["blockCicd","reportCicd","reportIssue"],"properties":{"blockCicd":{"type":"boolean","description":"Indicates if triggering the policy should block the CI image."},"reportCicd":{"type":"boolean","description":"Indicates if triggering the policy should soft fail the CI image in the platform."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the CI Image Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"imageRegistry":{"type":"object","description":"Configuration for the image registry trigger. If `true`, the policy is evaluated during registry image scans.","required":["actions","isEnabled","overrideIssueSeverity"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the Registry Image Scan trigger is enabled."},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}},"periodic":{"type":"object","minProperties":1,"maxProperties":3,"description":"Configuration for the periodic code scan (scheduled) trigger. If `true`, the policy is evaluated.","required":["actions","isEnabled"],"properties":{"actions":{"type":"object","minProperties":1,"maxProperties":2,"description":"Actions to take when the policy detects its target risk and the policy is triggered.","required":["reportIssue"],"properties":{"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."}}},"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the Periodic Scan trigger is enabled."},"overrideIssueSeverity":{"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","enum":["Critical","High","Medium","Low"],"nullable":true}}},"pr":{"type":"object","description":"Configuration for the pull request (PR) trigger. If `true`, the policy is evaluated on Pull Request (PR) events","minProperties":1,"maxProperties":3,"required":["actions","isEnabled"],"properties":{"actions":{"type":"object","description":"Actions to take when the policy detects its target risk and the policy is triggered. ","required":["blockPr","reportIssue","reportPrComment"],"properties":{"blockPr":{"type":"boolean","description":"Indicates if triggering the policy should block the pull request."},"reportIssue":{"type":"boolean","description":"Indicates if triggering the policy should create an issue."},"reportPrComment":{"type":"boolean","description":"Indicates if triggering the policy should create comments on the pull request."}}},"isEnabled":{"type":"boolean","description":"Indicates whether the PR Scan trigger is enabled.","default":true},"overrideIssueSeverity":{"enum":["Critical","High","Medium","Low"],"description":"**Optional**. Set the severity of the issue (and override the system severity). If not used or set to `null`, system severity is kept.","nullable":true}}}}}}}}
```

## The VcsUserPermissionLevel object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"VcsUserPermissionLevel":{"description":"The permission level of the user within the repository.","enum":["ADMIN","MAINTAIN","WRITE","READ","TRIAGE","OWNER","MAINTAINER","DEVELOPER","GUEST","REPORTER","PLANNER","NONE"],"type":"string"}}}}
```

## The EmailOrigin object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"EmailOrigin":{"description":"The source from which the user's email address was obtained.","enum":["API","GIT"],"type":"string"}}}}
```

## The RepositoryUser object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RepositoryUser":{"description":"Represents a user associated with a repository.","type":"object","additionalProperties":false,"required":["name","email","repositoryId","creationDate"],"properties":{"lastCommitDate":{"type":"string","description":"The date and time of the user's most recent commit. Used to determine contributor activity.\n**Note:** Only users who committed within the last 90 days are considered active contributors for billing."},"name":{"type":"string","description":"The display name of the repository user."},"userName":{"type":"string","description":"The username of the repository user on the VCS platform."},"email":{"type":"string","description":"The email address associated with the user. This value is used to uniquely identify contributors across repositories. Emails associated with bots or automated accounts (for example, action@github.com or *@users.noreply.github.com) are excluded."},"repositoryId":{"type":"string","description":"The unique identifier of the repository associated with the user. The repository must be billable (not archived and with at least one security scanner enabled)."},"creationDate":{"type":"string","description":"The date and time when the user record was created in the system."},"role":{"$ref":"#/components/schemas/VcsUserPermissionLevel"},"hasMfa":{"type":"boolean","description":"Indicates whether the user has multi-factor authentication (MFA) enabled on their VCS account."},"teams":{"type":"array","description":"The names of the teams in the VCS organization that the user belongs to.","items":{"type":"string"}},"isGuest":{"type":"boolean","description":"Indicates whether the user is a guest (external collaborator) in the repository."},"isContributor":{"type":"boolean","description":"Indicates whether the user is an active contributor."},"isAdmin":{"type":"boolean","description":"Indicates whether the user has admin permissions for the repository."},"emailOrigin":{"$ref":"#/components/schemas/EmailOrigin"},"uniqueVcsId":{"type":"string","description":"A unique identifier assigned to the user by the VCS platform. Used to correlate the user across repositories and systems."}}},"VcsUserPermissionLevel":{"description":"The permission level of the user within the repository.","enum":["ADMIN","MAINTAIN","WRITE","READ","TRIAGE","OWNER","MAINTAINER","DEVELOPER","GUEST","REPORTER","PLANNER","NONE"],"type":"string"},"EmailOrigin":{"description":"The source from which the user's email address was obtained.","enum":["API","GIT"],"type":"string"}}}}
```

## The BillingErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BillingErrorResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"The HTTP status code of the error."},"err_msg":{"type":"string","description":"A short description of the error type."},"err_extra":{"type":"string","description":"A detailed message explaining the cause of the error.","nullable":true}}}}}}}}
```

## The ConditionValue object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ConditionValue":{"properties":{"from":{"type":"number","format":"double","description":"The lower bound of a range query."},"to":{"type":"number","format":"double","description":"The upper bound of a range query."},"key":{"type":"string","description":"The key for key-value pair matching."},"value":{"type":"string","description":"The value for key-value pair matching."}},"type":"object","additionalProperties":false,"description":"A structured condition value used for range queries or key-value pair matching."}}}}
```

## The Trigger object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Trigger":{"enum":["periodic","cicd","pr","ciImage","imageRegistry"],"type":"string","description":"The type of trigger that evaluates the policy."}}}}
```

## The UnifiedAction object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UnifiedAction":{"description":"The type of action that can be taken when a policy is triggered.\n- `blockCicd`: Block the CI/CD pipeline\n- `blockCiImage`: Block the CI image build\n- `blockPr`: Block the pull request\n- `reportCicd`: Soft fail the CI/CD pipeline\n- `reportIssue`: Create an issue in the connected system\n- `reportPrComment`: Create comments on the pull request","enum":["blockCiImage","blockCicd","blockPr","reportCicd","reportIssue","reportPrComment"],"type":"string"}}}}
```

## The CreateIntegrationBody object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CreateIntegrationBody":{"type":"object","description":"Define the integration configuration","additionalProperties":false,"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/IntegrationType"},"domain":{"$ref":"#/components/schemas/IntegrationDomain"},"credentials":{"$ref":"#/components/schemas/Partial_IntegrationCredentials_"},"uniqueProperties":{"$ref":"#/components/schemas/Record_string.unknown_"},"status":{"$ref":"#/components/schemas/IntegrationStatus"},"transporter":{"$ref":"#/components/schemas/Transporter"},"selfSignedCertificate":{"type":"string","description":"PEM-encoded self-signed certificate for secure communication."}}},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "},"IntegrationDomain":{"type":"object","title":"IntegrationDomain","description":"Domain configuration specifying the hostname and protocol for the data source instance","additionalProperties":false,"required":["hostname","protocol"],"properties":{"hostname":{"type":"string","description":"Hostname or domain name of the external data source."},"protocol":{"$ref":"#/components/schemas/IntegrationProtocol"}}},"IntegrationProtocol":{"type":"string","enum":["http","https"],"title":"IntegrationProtocol","description":"Communication protocol used to connect to the data source."},"Partial_IntegrationCredentials_":{"type":"object","description":"Authentication credentials required to connect to the external data source. All properties are optional to support different authentication methods.","properties":{"type":{"$ref":"#/components/schemas/IntegrationCredentialsType"},"token":{"type":"string","description":"Authentication token, such as a personal access token (PAT), used to authenticate with the data source."},"refreshToken":{"type":"string","description":"Refresh token used to obtain a new authentication token when the current one expires."},"clientId":{"type":"string","description":"Client ID for OAuth-based authentication with the data source."},"clientSecret":{"type":"string","description":"Client secret for OAuth-based authentication with the data source."},"username":{"type":"string","description":"Username for basic authentication with the data source."},"password":{"type":"string","description":"Password for basic authentication with the data source."},"webhookAuthKeyId":{"type":"string","description":"Webhook authentication key ID used for webhook-based integrations."},"webhookAuthKey":{"type":"string","description":"Authentication key used to validate incoming webhook requests from the data source."}}},"IntegrationCredentialsType":{"type":"string","enum":["OAUTH","PAT"],"description":"Type of authentication method used for the data source connection."},"Record_string.unknown_":{"type":"object","description":"A flexible key-value map for specifying additional properties. Keys are strings and values can be of any type."},"IntegrationStatus":{"type":"string","enum":["COMPLETED","CONNECTED","DESTROYING","DISABLED","ERROR","PENDING","TEMPORARY","TRANSPORTER_CONNECTION_DISABLED","WARNING"],"title":"IntegrationStatus","description":"Current connection status of the data source instance.\n- `COMPLETED` — The data source instance setup is complete and operational.\n- `CONNECTED` — The data source instance is actively connected.\n- `DESTROYING` — The data source instance is being removed.\n- `DISABLED` — The data source instance is disabled and not actively scanning.\n- `ERROR` — The data source instance encountered an error and requires attention.\n- `PENDING` — The data source instance is being set up and is not yet active.\n- `TEMPORARY` — The data source instance is in a temporary state during configuration.\n- `TRANSPORTER_CONNECTION_DISABLED` — The transporter connection for this data source instance is disabled.\n- `WARNING` — The data source instance is operational but has warnings that may require attention."},"Transporter":{"description":"Transporter configuration for establishing secure communication between an on-premises or private data source and Cortex.","properties":{"brokerDeviceId":{"type":"string","description":"Unique identifier of the broker device used for the transporter connection."},"connectionName":{"type":"string","description":"Name of the transporter connection."}},"required":["brokerDeviceId","connectionName"],"type":"object","additionalProperties":false}}}}
```

## The ExternalProjectInput object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ExternalProjectInput":{"type":"object","additionalProperties":false,"properties":{"branchName":{"type":"string","nullable":true,"description":"Name of the branch"},"externalBranchName":{"type":"string","nullable":true,"description":"Name of the external branch"},"externalId":{"type":"string","description":"External ID"},"externalProjectId":{"type":"string","nullable":true,"description":"External project ID"},"repoId":{"type":"string","nullable":true,"description":"Repository ID"}},"required":["branchName","externalBranchName","externalId","externalProjectId","repoId"]}}}}
```

## The Integration object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Integration":{"type":"object","title":"Integration","description":"Integration details","additionalProperties":false,"required":["creationDate","id","lastUpdateDate","type"],"properties":{"creationDate":{"type":"string","description":"Date and time when the data source instance was created."},"domain":{"$ref":"#/components/schemas/IntegrationDomain"},"id":{"type":"string","description":"Unique identifier (ID) of the data source instance."},"instanceVersion":{"type":"string","description":"Version of the data source instance configuration."},"lastUpdateDate":{"type":"string","description":"Date and time when the data source instance was last updated."},"scanTypes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/scanType"}},"selectionType":{"$ref":"#/components/schemas/SelectionType"},"selfSignedCertificate":{"type":"string","description":"PEM-encoded self-signed certificate used for secure communication with the data source."},"state":{"type":"array","description":"Integration state","items":{"type":"string"}},"statusDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationStatusDetails"}},"tenantId":{"type":"string","description":"Tenant ID that owns this data source instance."},"transporter":{"$ref":"#/components/schemas/Transporter"},"type":{"$ref":"#/components/schemas/IntegrationType"},"typeCategory":{"$ref":"#/components/schemas/TypeCategory"},"uniqueIdentifier":{"type":"string","description":"Unique identifier of the integration"}}},"IntegrationDomain":{"type":"object","title":"IntegrationDomain","description":"Domain configuration specifying the hostname and protocol for the data source instance","additionalProperties":false,"required":["hostname","protocol"],"properties":{"hostname":{"type":"string","description":"Hostname or domain name of the external data source."},"protocol":{"$ref":"#/components/schemas/IntegrationProtocol"}}},"IntegrationProtocol":{"type":"string","enum":["http","https"],"title":"IntegrationProtocol","description":"Communication protocol used to connect to the data source."},"scanType":{"type":"object","additionalProperties":false,"description":"Configuration for a specific scan type within a data source instance.","required":["isEnabled"],"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scan type is enabled for the data source instance."}}},"SelectionType":{"type":"string","enum":["CURRENT_STATE","CURRENT_STATE_AND_FUTURE","CURRENT_STATE_PENDING","MANUAL_SELECTION"],"description":"Defines how repositories are selected for scanning within a data source instance."},"IntegrationStatusDetails":{"description":"Detailed status information for a specific component of the data source instance.","properties":{"error":{"type":"string","description":"Error code or identifier if the component is in an error state."},"message":{"type":"string","description":"Human-readable message providing additional context about the status."},"status":{"$ref":"#/components/schemas/StatusValue"},"timestamp":{"type":"string","description":"ISO 8601 timestamp indicating when the status was last evaluated."}},"required":["status"],"type":"object","additionalProperties":false},"StatusValue":{"type":"string","enum":["INVALID","VALID"]},"Transporter":{"description":"Transporter configuration for establishing secure communication between an on-premises or private data source and Cortex.","properties":{"brokerDeviceId":{"type":"string","description":"Unique identifier of the broker device used for the transporter connection."},"connectionName":{"type":"string","description":"Name of the transporter connection."}},"required":["brokerDeviceId","connectionName"],"type":"object","additionalProperties":false},"IntegrationType":{"type":"string","enum":["COLLECTOR"],"title":"IntegrationType","description":"Type of the data source instance, indicating the external system it connects to. "},"TypeCategory":{"type":"string","description":"Category classification of the data source instance type.\n- `DEFAULT` — Standard data source instances such as VCS, CI/CD, and CLI integrations.\n- `EXTERNAL_VENDOR_INTEGRATIONS` — Third-party external vendor integrations.","enum":["DEFAULT","EXTERNAL_VENDOR_INTEGRATIONS"]}}}}
```

## The IntegrationCredentialsType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationCredentialsType":{"type":"string","enum":["OAUTH","PAT"],"description":"Type of authentication method used for the data source connection."}}}}
```

## The IntegrationDomain object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationDomain":{"type":"object","title":"IntegrationDomain","description":"Domain configuration specifying the hostname and protocol for the data source instance","additionalProperties":false,"required":["hostname","protocol"],"properties":{"hostname":{"type":"string","description":"Hostname or domain name of the external data source."},"protocol":{"$ref":"#/components/schemas/IntegrationProtocol"}}},"IntegrationProtocol":{"type":"string","enum":["http","https"],"title":"IntegrationProtocol","description":"Communication protocol used to connect to the data source."}}}}
```

## The IntegrationProtocol object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationProtocol":{"type":"string","enum":["http","https"],"title":"IntegrationProtocol","description":"Communication protocol used to connect to the data source."}}}}
```

## The IntegrationStatus object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationStatus":{"type":"string","enum":["COMPLETED","CONNECTED","DESTROYING","DISABLED","ERROR","PENDING","TEMPORARY","TRANSPORTER_CONNECTION_DISABLED","WARNING"],"title":"IntegrationStatus","description":"Current connection status of the data source instance.\n- `COMPLETED` — The data source instance setup is complete and operational.\n- `CONNECTED` — The data source instance is actively connected.\n- `DESTROYING` — The data source instance is being removed.\n- `DISABLED` — The data source instance is disabled and not actively scanning.\n- `ERROR` — The data source instance encountered an error and requires attention.\n- `PENDING` — The data source instance is being set up and is not yet active.\n- `TEMPORARY` — The data source instance is in a temporary state during configuration.\n- `TRANSPORTER_CONNECTION_DISABLED` — The transporter connection for this data source instance is disabled.\n- `WARNING` — The data source instance is operational but has warnings that may require attention."}}}}
```

## The IntegrationStatusDetails object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"IntegrationStatusDetails":{"description":"Detailed status information for a specific component of the data source instance.","properties":{"error":{"type":"string","description":"Error code or identifier if the component is in an error state."},"message":{"type":"string","description":"Human-readable message providing additional context about the status."},"status":{"$ref":"#/components/schemas/StatusValue"},"timestamp":{"type":"string","description":"ISO 8601 timestamp indicating when the status was last evaluated."}},"required":["status"],"type":"object","additionalProperties":false},"StatusValue":{"type":"string","enum":["INVALID","VALID"]}}}}
```

## The Partial\_IntegrationCredentials\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Partial_IntegrationCredentials_":{"type":"object","description":"Authentication credentials required to connect to the external data source. All properties are optional to support different authentication methods.","properties":{"type":{"$ref":"#/components/schemas/IntegrationCredentialsType"},"token":{"type":"string","description":"Authentication token, such as a personal access token (PAT), used to authenticate with the data source."},"refreshToken":{"type":"string","description":"Refresh token used to obtain a new authentication token when the current one expires."},"clientId":{"type":"string","description":"Client ID for OAuth-based authentication with the data source."},"clientSecret":{"type":"string","description":"Client secret for OAuth-based authentication with the data source."},"username":{"type":"string","description":"Username for basic authentication with the data source."},"password":{"type":"string","description":"Password for basic authentication with the data source."},"webhookAuthKeyId":{"type":"string","description":"Webhook authentication key ID used for webhook-based integrations."},"webhookAuthKey":{"type":"string","description":"Authentication key used to validate incoming webhook requests from the data source."}}},"IntegrationCredentialsType":{"type":"string","enum":["OAUTH","PAT"],"description":"Type of authentication method used for the data source connection."}}}}
```

## The Record\_string.unknown\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Record_string.unknown_":{"type":"object","description":"A flexible key-value map for specifying additional properties. Keys are strings and values can be of any type."}}}}
```

## The SelectionType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"SelectionType":{"type":"string","enum":["CURRENT_STATE","CURRENT_STATE_AND_FUTURE","CURRENT_STATE_PENDING","MANUAL_SELECTION"],"description":"Defines how repositories are selected for scanning within a data source instance."}}}}
```

## The Transporter object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"Transporter":{"description":"Transporter configuration for establishing secure communication between an on-premises or private data source and Cortex.","properties":{"brokerDeviceId":{"type":"string","description":"Unique identifier of the broker device used for the transporter connection."},"connectionName":{"type":"string","description":"Name of the transporter connection."}},"required":["brokerDeviceId","connectionName"],"type":"object","additionalProperties":false}}}}
```

## The TypeCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"TypeCategory":{"type":"string","description":"Category classification of the data source instance type.\n- `DEFAULT` — Standard data source instances such as VCS, CI/CD, and CLI integrations.\n- `EXTERNAL_VENDOR_INTEGRATIONS` — Third-party external vendor integrations.","enum":["DEFAULT","EXTERNAL_VENDOR_INTEGRATIONS"]}}}}
```

## The UpdateIntegrationPublicBody object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UpdateIntegrationPublicBody":{"type":"object","title":"UpdateIntegrationPublicBody","description":"Define the integration details","additionalProperties":false,"properties":{"selectionType":{"$ref":"#/components/schemas/SelectionType"},"state":{"type":"array","description":"To update the integration for specific repositories, specify them here in the following format:\n\n`\"state\":\"[\"org1\"/\"repo_name1\", \"org2\"/\"repo_name2\"]`","items":{"type":"string"}},"externalProjects":{"type":"array","items":{"$ref":"#/components/schemas/ExternalProjectInput"}},"uniqueProperties":{"$ref":"#/components/schemas/Record_string.unknown_"}}},"SelectionType":{"type":"string","enum":["CURRENT_STATE","CURRENT_STATE_AND_FUTURE","CURRENT_STATE_PENDING","MANUAL_SELECTION"],"description":"Defines how repositories are selected for scanning within a data source instance."},"ExternalProjectInput":{"type":"object","additionalProperties":false,"properties":{"branchName":{"type":"string","nullable":true,"description":"Name of the branch"},"externalBranchName":{"type":"string","nullable":true,"description":"Name of the external branch"},"externalId":{"type":"string","description":"External ID"},"externalProjectId":{"type":"string","nullable":true,"description":"External project ID"},"repoId":{"type":"string","nullable":true,"description":"Repository ID"}},"required":["branchName","externalBranchName","externalId","externalProjectId","repoId"]},"Record_string.unknown_":{"type":"object","description":"A flexible key-value map for specifying additional properties. Keys are strings and values can be of any type."}}}}
```

## The UrlIntegrationType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UrlIntegrationType":{"enum":["github","github-enterprise","gitlab","gitlab-self-managed","azure-repos","cortex-cli","bitbucket","bitbucket-datacenter","aws-code-commit","hcp-tfc-run-tasks","hcp-tfe-run-tasks","sonar-qube","veracode","semgrep","circle-ci-cd","jenkins-server","aws-code-build","circle-ci","github-actions","jenkins","collector","snyk","jfrog"],"type":"string"}}}}
```

## The UrlIntegrationTypeCategory object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UrlIntegrationTypeCategory":{"type":"string","enum":["external-vendor-integrations","vcs-integrations","ci-cd-scanning-integrations","cli-integrations"]}}}}
```

## The scanType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"scanType":{"type":"object","additionalProperties":false,"description":"Configuration for a specific scan type within a data source instance.","required":["isEnabled"],"properties":{"isEnabled":{"type":"boolean","description":"Indicates whether this scan type is enabled for the data source instance."}}}}}}
```

## The PackageType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PackageType":{"type":"string","enum":["OSS","OS"],"description":"Type of the package. OSS indicates an open-source software package; OS indicates an operating system package."}}}}
```

## The UsedInCounts object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"UsedInCounts":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"number","format":"double","description":"Number of code repositories that include this package.","nullable":true},"runtime":{"type":"number","format":"double","description":"Number of runtime environments where this package is detected.","nullable":true},"deploy":{"type":"number","format":"double","description":"Number of deployed artifacts or images that include this package.","nullable":true}}}}}}
```

## The VulnerabilityCounts object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"VulnerabilityCounts":{"type":"object","additionalProperties":false,"properties":{"critical":{"type":"number","format":"double","description":"Number of critical-severity vulnerabilities associated with this package version.","nullable":true},"high":{"type":"number","format":"double","description":"Number of high-severity vulnerabilities associated with this package version.","nullable":true},"medium":{"type":"number","format":"double","description":"Number of medium-severity vulnerabilities associated with this package version.","nullable":true},"low":{"type":"number","format":"double","description":"Number of low-severity vulnerabilities associated with this package version.","nullable":true},"info":{"type":"number","format":"double","description":"Number of informational vulnerabilities associated with this package version.","nullable":true}}}}}}
```

## The PackageExplorerResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"PackageExplorerResponse":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the package as it appears in the package manager registry."},"version":{"type":"string","description":"The version of the package."},"package_type":{"allOf":[{"$ref":"#/components/schemas/PackageType"}],"nullable":true},"ecosystem":{"type":"string","description":"The package manager ecosystem where this package is used (for example, NPM, YARN, MAVEN, or GRADLE). Each result represents an ecosystem where the package version was detected.","nullable":true},"operational_risk":{"type":"string","description":"The assessed operational risk level of the package version (for example, LOW, MEDIUM, or HIGH). Returns `null` if no assessment is available.","nullable":true},"used_in":{"allOf":[{"$ref":"#/components/schemas/UsedInCounts"}],"nullable":true,"description":"Usage counts showing where this package version is used, including code repositories, runtime environments, and deployed artifacts within the ecosystem."},"vulnerabilities":{"allOf":[{"$ref":"#/components/schemas/VulnerabilityCounts"}],"nullable":true,"description":"Number of known vulnerabilities for this package version by severity level.\n"}}},"PackageType":{"type":"string","enum":["OSS","OS"],"description":"Type of the package. OSS indicates an open-source software package; OS indicates an operating system package."},"UsedInCounts":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"number","format":"double","description":"Number of code repositories that include this package.","nullable":true},"runtime":{"type":"number","format":"double","description":"Number of runtime environments where this package is detected.","nullable":true},"deploy":{"type":"number","format":"double","description":"Number of deployed artifacts or images that include this package.","nullable":true}}},"VulnerabilityCounts":{"type":"object","additionalProperties":false,"properties":{"critical":{"type":"number","format":"double","description":"Number of critical-severity vulnerabilities associated with this package version.","nullable":true},"high":{"type":"number","format":"double","description":"Number of high-severity vulnerabilities associated with this package version.","nullable":true},"medium":{"type":"number","format":"double","description":"Number of medium-severity vulnerabilities associated with this package version.","nullable":true},"low":{"type":"number","format":"double","description":"Number of low-severity vulnerabilities associated with this package version.","nullable":true},"info":{"type":"number","format":"double","description":"Number of informational vulnerabilities associated with this package version.","nullable":true}}}}}}
```

## The CoveragePublicApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CoveragePublicApiResponse":{"description":"Returns the coverage ratio for the requested `direction` and `type`.","type":"object","additionalProperties":false,"properties":{"coverage":{"type":"number","format":"double","description":"The coverage ratio, as a decimal between `0` and `1`. Multiply by 100 to get the percentage shown on the Code to Cloud dashboard. Returns `0` if there isn't enough data to calculate coverage."}}}}}}
```

## The CodeToCloudDirection object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CodeToCloudDirection":{"type":"string","description":"The direction to trace lineage","enum":["code_to_cloud","cloud_to_code"]}}}}
```

## The CodeToCloudDashboardType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"CodeToCloudDashboardType":{"type":"string","description":"The asset type to calculate coverage","enum":["artifact","infrastructure"]}}}}
```

## The OperationType object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"OperationType":{"type":"string","description":"The type of override operation to apply to the specified assets.\n- `ADD` - Adds the assets to the application.\n- `REMOVE` - Removes the assets from the application.","enum":["ADD","REMOVE"]}}}}
```

## The OverrideAssetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"OverrideAssetsRequest":{"type":"object","description":"The assets to add or remove and the operation to apply.","properties":{"assetIds":{"type":"array","description":"The unique identifiers of the assets to add or remove. To find assets that you can add, use List addable assets. To find assets that you can remove, use List removable assets.","items":{"type":"string"}},"operation":{"description":"The override operation to apply to the specified assets.","$ref":"#/components/schemas/OperationType"},"filter":{"type":"string","description":"An optional filter expression that is stored with the override action, such as `assetProvider=AWS`. The `assetIds` field is always required, even when you provide a filter. The filter is recorded with the action and is returned in the `filter` field of List override actions."}},"required":["assetIds","operation"],"additionalProperties":false},"OperationType":{"type":"string","description":"The type of override operation to apply to the specified assets.\n- `ADD` - Adds the assets to the application.\n- `REMOVE` - Removes the assets from the application.","enum":["ADD","REMOVE"]}}}}
```

## The OverrideAssetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"OverrideAssetsResponse":{"type":"object","description":"The result of an add or remove override operation.","additionalProperties":false,"properties":{"success":{"type":"boolean","description":"Indicates whether the override operation completed successfully."},"actionId":{"type":"string","description":"The unique identifier of the override action. Use this value to revert the action with Revert overrides by action ID."},"processed":{"type":"array","description":"The unique identifiers of the assets that the operation processed successfully.","items":{"type":"string"}},"failed":{"type":"array","description":"The assets that the operation failed to process, together with the reason for each failure.","items":{"type":"object","properties":{"reason":{"type":"string","description":"The reason that the asset failed to process."},"assetId":{"type":"string","description":"The unique identifier of the asset that failed to process."}}}}}}}}}
```

## The ApplicationAssetOverrideResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ApplicationAssetOverrideResponse":{"type":"object","description":"A single override action that was applied to the application.","additionalProperties":false,"properties":{"actionId":{"type":"string","description":"The unique identifier of the override action. Use this value to revert the action with Revert overrides by action ID."},"assetIds":{"type":"array","description":"The unique identifiers of the assets that the override action affected.","items":{"type":"string"}},"operationType":{"$ref":"#/components/schemas/OperationType"},"userEmail":{"type":"string","description":"The email address of the user who performed the override action. When an API token performs the action, this value identifies the token."},"filter":{"type":"string","description":"The filter expression that was used to select the assets, or `null` if the action did not use a filter.","nullable":true},"createdAt":{"type":"string","description":"The date and time when the override action was created, in ISO 8601 format."}}},"OperationType":{"type":"string","description":"The type of override operation to apply to the specified assets.\n- `ADD` - Adds the assets to the application.\n- `REMOVE` - Removes the assets from the application.","enum":["ADD","REMOVE"]}}}}
```

## The BasicPaginatedResponse\_ApplicationAssetOverrideResponse-Array\_ object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"BasicPaginatedResponse_ApplicationAssetOverrideResponse-Array_":{"type":"object","description":"A paginated list of override actions that were applied to the application.","additionalProperties":false,"properties":{"data":{"type":"array","description":"The override actions on the current page.","items":{"$ref":"#/components/schemas/ApplicationAssetOverrideResponse"}},"hasNext":{"type":"boolean","description":"Indicates whether more pages of results are available. When the value is `true`, request the next page to retrieve additional results."}}},"ApplicationAssetOverrideResponse":{"type":"object","description":"A single override action that was applied to the application.","additionalProperties":false,"properties":{"actionId":{"type":"string","description":"The unique identifier of the override action. Use this value to revert the action with Revert overrides by action ID."},"assetIds":{"type":"array","description":"The unique identifiers of the assets that the override action affected.","items":{"type":"string"}},"operationType":{"$ref":"#/components/schemas/OperationType"},"userEmail":{"type":"string","description":"The email address of the user who performed the override action. When an API token performs the action, this value identifies the token."},"filter":{"type":"string","description":"The filter expression that was used to select the assets, or `null` if the action did not use a filter.","nullable":true},"createdAt":{"type":"string","description":"The date and time when the override action was created, in ISO 8601 format."}}},"OperationType":{"type":"string","description":"The type of override operation to apply to the specified assets.\n- `ADD` - Adds the assets to the application.\n- `REMOVE` - Removes the assets from the application.","enum":["ADD","REMOVE"]}}}}
```

## The RevertOverridesResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"RevertOverridesResponse":{"type":"object","description":"The result of a revert operation.","additionalProperties":false,"properties":{"success":{"type":"boolean","description":"Indicates whether the revert operation completed successfully."},"reverted":{"type":"array","description":"The unique identifiers of the assets whose override was reverted.","items":{"type":"string"}}}}}}}
```

## The ManageableAsset object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"ManageableAsset":{"type":"object","description":"An asset that you can add to or remove from the application.","additionalProperties":false,"properties":{"assetId":{"type":"string","description":"The unique identifier of the asset. Use this value in the `assetIds` field when you add or remove assets."},"assetName":{"type":"string","description":"The display name of the asset, or `null` when the asset does not have a name."},"assetTypeCategory":{"type":"string","description":"The category of the asset type, such as `Certificate` or `Repository`."},"assetTypeId":{"type":"string","description":"The identifier of the asset type, such as `TLS_CERTIFICATE` or `GITHUB_REPOSITORY`."},"assetTypeClass":{"type":"string","description":"The class of the asset type, such as `Identity`, `Code`, or `Compute`."},"assetProvider":{"type":"string","description":"The provider that the asset belongs to, such as `AWS`, `GITHUB`, or `OTHER`."},"assetCloudRegion":{"type":"string","description":"The cloud region where the asset is located, such as `us-east-1`. The value is empty or `null` when a region does not apply to the asset."}}}}}}
```

## The GetManageableAssetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"GetManageableAssetsResponse":{"type":"object","description":"A paginated list of assets that you can add to or remove from the application.","additionalProperties":false,"properties":{"items":{"type":"array","description":"The assets on the current page.","items":{"$ref":"#/components/schemas/ManageableAsset"}},"currentPage":{"type":"number","format":"double","description":"The number of the current page. Pages are numbered starting at 1."},"totalPages":{"type":"number","format":"double","description":"The total number of pages that are available for the current page size."},"pageSize":{"type":"number","format":"double","description":"The number of assets that are returned on each page."},"totalItems":{"type":"number","format":"double","description":"The total number of assets that match the request."}}},"ManageableAsset":{"type":"object","description":"An asset that you can add to or remove from the application.","additionalProperties":false,"properties":{"assetId":{"type":"string","description":"The unique identifier of the asset. Use this value in the `assetIds` field when you add or remove assets."},"assetName":{"type":"string","description":"The display name of the asset, or `null` when the asset does not have a name."},"assetTypeCategory":{"type":"string","description":"The category of the asset type, such as `Certificate` or `Repository`."},"assetTypeId":{"type":"string","description":"The identifier of the asset type, such as `TLS_CERTIFICATE` or `GITHUB_REPOSITORY`."},"assetTypeClass":{"type":"string","description":"The class of the asset type, such as `Identity`, `Code`, or `Compute`."},"assetProvider":{"type":"string","description":"The provider that the asset belongs to, such as `AWS`, `GITHUB`, or `OTHER`."},"assetCloudRegion":{"type":"string","description":"The cloud region where the asset is located, such as `us-east-1`. The value is empty or `null` when a region does not apply to the asset."}}}}}}
```

## The AddableAssetFilter object

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex XSIAM 3.6"},"components":{"schemas":{"AddableAssetFilter":{"type":"string","description":"A predefined shortcut that filters the assets that are available to add.\n- `RecentlyDiscovered` - Returns assets that were discovered recently.\n- `OrphanAssets` - Returns assets that are not associated with any application.\n- `SameContributors` - Returns assets that share contributors with the application.","enum":["RecentlyDiscovered","OrphanAssets","SameContributors"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/xsiam-api/aspm-cicd-and-application-security/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.