openapi: 3.2.0 info: description: 'Use the Cloud Guard and Security Zones API to automate processes that you would otherwise perform through the Cloud Guard Console or the Security Zones Console. For more information on these services, see the [Cloud Guard](/iaas/cloud-guard/home.htm) and [Security Zones](/iaas/security-zone/home.htm) documentation. **Note:** For Cloud Guard, you can perform Create, Update, and Delete operations only from the reporting region of your Cloud Guard tenancy. You can perform Read operations from any region. ' title: Security Zones Cloud Guard API version: '20200131' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/5ce6f7a2dc8ae83e765505000994c2e7501593d31452e63eb7435abfd240de42.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Cloud Guard and Security Zones API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/5ce6f7a2dc8ae83e765505000994c2e7501593d31452e63eb7435abfd240de42.yaml what: the harvested document for Cloud Guard and Security Zones API servers: - url: http://127.0.0.1/20200131 - url: https://127.0.0.1/20200131 tags: - name: cloudGuard paths: /actions/validateCredentials: post: description: 'Validates service user credentials for an SaaS applications such as Fusion Apps. Returns detailed credential validation information (CredentialsValidationDetails resource) for credential information passed in a ValidateCredentialsDetails resource. ' operationId: ValidateCredentials parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Credentials validation response details headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CredentialsValidationDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Validates service user credentials for an SaaS applications such as Fusion Apps. Returns detailed credential validation information (CredentialsValidationDetails resource) for credential information passed in a ValidateCredentialsDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/CredentialsValidationDetailsItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateCredentialsDetails' description: Credentials to be validated required: true /conditionMetadataTypes: get: description: 'Returns a list of ConditionMetadataType resources. ' operationId: ListConditionMetadataTypes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of ConditionMetadataType resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConditionMetadataTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of ConditionMetadataType resources. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/ConditionMetadataType' /conditionMetadataTypes/{conditionMetadataTypeId}: get: description: 'Returns a ConditionMetatDataType resource with its details. ' operationId: GetConditionMetadataType parameters: - $ref: '#/components/parameters/ConditionMetadataTypePathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ConditionServiceTypeQueryParam' - $ref: '#/components/parameters/ConditionResourceTypeQueryParam' responses: 200: description: The details of the ConditionMetatDataType resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConditionMetadataType' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a ConditionMetatDataType resource with its details. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false /configuration: get: description: 'Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID. ' operationId: GetConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The configuration details of the Cloud Guard resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/Configuration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID. ' tags: - cloudGuard x-related-resource: '#/definitions/Configuration' put: description: 'Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created. ' operationId: UpdateConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Updated Cloud Guard configuration details headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Configuration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created. ' tags: - cloudGuard x-related-resource: '#/definitions/Configuration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationDetails' description: Updates configuration details of Cloud Guard for a Tenancy. required: true /dataMaskRules: get: description: 'Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments. ' operationId: ListDataMaskRules parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DataMaskRuleStatusQueryParam' - $ref: '#/components/parameters/DataMaskRuleTargetIdQueryParam' - $ref: '#/components/parameters/DataMaskRuleIAMGroupIdQueryParam' - $ref: '#/components/parameters/DataMaskRuleTargetTypeQueryParam' responses: 200: description: DataMaskRuleCollection resource with page of DataMaskRuleSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataMaskRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments. tags: - cloudGuard x-related-resource: '#/definitions/DataMaskRule' post: description: 'Creates a new DataMaskRule resource definition. ' operationId: CreateDataMaskRule parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DataMaskRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataMaskRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DataMaskRule resource definition. tags: - cloudGuard x-related-resource: '#/definitions/DataMaskRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataMaskRuleDetails' description: Definition for the new data mask rule required: true /dataMaskRules/{dataMaskRuleId}: delete: description: Deletes a DataMaskRule resource, identified by dataMaskRuleId. operationId: DeleteDataMaskRule parameters: - $ref: '#/components/parameters/DataMaskRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a DataMaskRule resource, identified by dataMaskRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DataMaskRule' get: description: Returns a DataMaskRule resource, identified by dataMaskRuleId. operationId: GetDataMaskRule parameters: - $ref: '#/components/parameters/DataMaskRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DataMaskRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataMaskRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a resource object, identified by dataMaskRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DataMaskRule' put: description: Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId. operationId: UpdateDataMaskRule parameters: - $ref: '#/components/parameters/DataMaskRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated DataMaskRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataMaskRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DataMaskRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataMaskRuleDetails' description: The data mask rule information to be updated required: true /dataSources: get: description: 'Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId. List is returned in a DataSourceCollection resource with page of DataSourceSummary resources. The ListAdhocQueries operation returns only the adhoc queries in ''compartmentId'' passed. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListDataSources parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DataSourceFeedProviderQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/LoggingQueryTypeQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DataSourceCollection resource with page of DataSourceSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId. List is returned in a DataSourceCollection resource with page of DataSourceSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/DataSource' post: description: 'Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource. ' operationId: CreateDataSource parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/DataSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataSourceDetails' description: Details for the new DataSource resource required: true /dataSources/{dataSourceId}: delete: description: Deletes a data source (DataSource resource) identified by dataSourceId. operationId: DeleteDataSource parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a data source (DataSource resource) identified by dataSourceId. tags: - cloudGuard x-related-resource: '#/definitions/DataSource' get: description: Returns a data source (DataSource resource) identified by dataSourceId. operationId: GetDataSource parameters: - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DataSource resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a data source (DataSource resource) identified by dataSourceId. tags: - cloudGuard x-related-resources: '#/definitions/DataSource' put: description: 'Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource. ' operationId: UpdateDataSource parameters: - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/DataSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataSourceDetails' description: Details for the DataSource resource to be updated required: true /dataSources/{dataSourceId}/actions/changeCompartment: post: description: 'Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another. ' operationId: ChangeDataSourceCompartment parameters: - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another. ' tags: - cloudGuard x-related-resource: '#/definitions/DataSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataSourceCompartmentDetails' description: The compartment OCID of the DataSource resource required: true /dataSources/{dataSourceId}/events: get: description: 'Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId. ' operationId: ListDataSourceEvents parameters: - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/RegionIdentifierQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DataSourceEventsCollection resource with a page of DataSourceEventSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSourceEventCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId. ' tags: - cloudGuard x-related-resource: '#/definitions/DataSource' /detectorRecipes: get: description: 'Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId. The ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListDetectorRecipes on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListDetectorRecipes parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ResourceMetadataOnlyQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRecipeCollection resource with page of DetectorRecipeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of all detector recipes (DetectorRecipe objects) in a compartment, identified by compartmentId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipe' post: description: 'Creates a new DetectorRecipe resource. ' operationId: CreateDetectorRecipe parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: CreateDetectorRecipeDetails resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DetectorRecipe resource. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDetectorRecipeDetails' description: Details for the new DetectorRecipe required: true /detectorRecipes/{detectorRecipeId}: delete: description: Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. operationId: DeleteDetectorRecipe parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipe' get: description: Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. operationId: GetDetectorRecipe parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. tags: - cloudGuard put: description: Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. operationId: UpdateDetectorRecipe parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: DetectorRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. tags: - cloudGuard requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDetectorRecipeDetails' description: Details for the DetectorRecipe to be updated required: true /detectorRecipes/{detectorRecipeId}/actions/changeCompartment: post: description: 'Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource. ' operationId: ChangeDetectorRecipeCompartment parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource. ' tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDetectorRecipeCompartmentDetails' description: The target compartment OCID required: true /detectorRecipes/{detectorRecipeId}/detectorRules: get: description: 'Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId. ' operationId: ListDetectorRecipeDetectorRules parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRecipeDetectorRuleCollection resource with page of DetectorRecipeDetectorRuleSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' post: description: Creates a detector rule. operationId: CreateDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Created DetectorRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a detector rule. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDetectorRecipeDetectorRuleDetails' description: The details with which detector rule is to be created. required: true /detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}: delete: description: Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId. operationId: DeleteDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' get: description: Returns a detector rule (DetectorRule resource) identified by detectorRuleId. operationId: GetDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRule resource associated with the DetectoRecipe resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a detector rule (DetectorRule resource) identified by detectorRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' put: description: Updates a detector rule (DetectorRule resource) identified by detectorRuleId. operationId: UpdateDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated DetectorRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a detector rule (DetectorRule resource) identified by detectorRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDetectorRecipeDetectorRuleDetails' description: The details to be updated for DetectorRule required: true /detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/dataSources/{dataSourceId}: delete: description: Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier. operationId: DeleteDetectorRecipeDetectorRuleDataSource parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRule' /detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes: get: description: 'Returns a list of all SightingTypes identified by detectorRuleId. The ListSightingTypes operation returns only sightingTypes that match the passed filters. ' operationId: ListDetectorRecipeDetectorRuleSightingTypes parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SightingTypeCollection resource with a page of SightingTypeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRuleSightingTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of all SightingTypes identified by detectorRuleId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRuleSightingTypeSummary' post: description: Adds a sighting type to a detector rule associated with a detector recipe. operationId: CreateDetectorRecipeDetectorRuleSightingType parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Details for SightingType headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRuleSightingType' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Adds a sighting type to a detector rule associated with a detector recipe. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRuleSightingType' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDetectorRecipeDetectorRuleSightingTypeDetails' description: The details with which SightingType is to be created for a detector rule required: true /detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes/{sightingTypeId}: delete: description: Deletes a SightingType associated with a detector rule operationId: DeleteDetectorRecipeDetectorRuleSightingType parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/SightingTypeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a SightingType associated with a detector rule tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRuleSightingType' put: description: Updates a sighting type attached to a detector rule associated with a detector recipe. operationId: UpdateDetectorRecipeDetectorRuleSightingType parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/SightingTypeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Sighting type is updated for the specified detector rule headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRecipeDetectorRuleSightingType' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a sighting type attached to a detector rule associated with a detector recipe. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRuleSightingType' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDetectorRecipeDetectorRuleSightingTypeDetails' description: The details with which the sighting type is to be updated required: true ? /detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes/{sightingTypeId}/dataSources/{dataSourceId} : delete: description: Detach the DetectorRecipeDetectorRuleSightingTypeDataSource resource identified by ID. operationId: DetachDetectorRecipeDetectorRuleSightingTypeDataSource parameters: - $ref: '#/components/parameters/DetectorRecipeIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/SightingTypeIdPathParam' - $ref: '#/components/parameters/DataSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Detach the DetectorRecipeDetectorRuleSightingTypeDataSource resource identified by ID. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRecipeDetectorRuleSightingType' /detectors: get: description: 'Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources. ' operationId: ListDetectors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorCollection resource with page of DetectorSummary resources. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources. tags: - cloudGuard x-related-resource: '#/definitions/Detector' /detectors/{detectorId}: get: description: 'Returns a Detector resource, identified by detectorId. ' operationId: GetDetector parameters: - $ref: '#/components/parameters/DetectorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Detector resource. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Detector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a Detector resource, identified by detectorId. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false /detectors/{detectorId}/detectorRules: get: description: 'Returns a list of detector rules for the DetectorRecipe resource identified by detectorId. ' operationId: ListDetectorRules parameters: - $ref: '#/components/parameters/DetectorIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DetectorRuleIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/RuleCategoryQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRuleCollection resource with page of DetectorRuleSummary resources. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of detector rules for the DetectorRecipe resource identified by detectorId. tags: - cloudGuard x-related-resource: '#/definitions/DetectorRule' /detectors/{detectorId}/detectorRules/{detectorRuleId}: get: description: 'Returns a detector rule (DetectorRule resource) identified by detectorRuleId. ' operationId: GetDetectorRule parameters: - $ref: '#/components/parameters/DetectorIdPathParam' - $ref: '#/components/parameters/DetectorRuleIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Detector rule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a detector rule (DetectorRule resource) identified by detectorRuleId. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false /managedListTypes: get: description: Returns all managed list types (listType parameter) that Cloud Guard supports. operationId: ListManagedListTypes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ManagedListTypeCollection resource with page of ManagedListTypeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedListTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns all managed list types (listType parameter) that Cloud Guard supports. tags: - cloudGuard x-related-resource: '#/definitions/ManagedListTypeSummary' /managedLists: get: description: 'Returns a list of all ManagedList resources in a compartment, identified by compartmentId. The ListManagedLists operation returns only the managed lists in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListManagedLists on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListManagedLists parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ResourceMetadataOnlyQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/ListTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ManagedListCollection resource with page of ManagedListSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedListCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of all ManagedList resources in a compartment, identified by compartmentId. tags: - cloudGuard x-related-resource: '#/definitions/ManagedList' post: description: 'Creates a new ManagedList resource. ' operationId: CreateManagedList parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The ManagedList resource is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ManagedList resource. tags: - cloudGuard x-related-resource: '#/definitions/ManagedList' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateManagedListDetails' description: Details for the new ManagedList resources required: true /managedLists/{managedListId}: delete: description: Deletes a managed list identified by managedListId. operationId: DeleteManagedList parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ManagedListIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a managed list identified by managedListId. tags: - cloudGuard x-related-resource: '#/definitions/ManagedList' get: description: Returns a managed list identified by managedListId. operationId: GetManagedList parameters: - $ref: '#/components/parameters/ManagedListIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ManagedList resources headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a managed list identified by managedListId. tags: - cloudGuard put: description: Updates a ManagedList resource, identified by managedList. operationId: UpdateManagedList parameters: - $ref: '#/components/parameters/ManagedListIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Updated ManagedList resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a ManagedList resource, identified by managedList. tags: - cloudGuard requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagedListDetails' description: Details for the ManagedList resource to be updated required: true /managedLists/{managedListId}/actions/changeCompartment: post: description: Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment. operationId: ChangeManagedListCompartment parameters: - $ref: '#/components/parameters/ManagedListIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment. tags: - cloudGuard x-related-resource: '#/definitions/ManagedList' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeManagedListCompartmentDetails' description: The compartment OCID of the ManagedList required: true /mitreTactics: get: description: 'Returns a list of Cloud Guard supported MITRE ATT@CK framework tactics. ' operationId: ListMitreTactics parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of MITRE ATT@CK framework tactics summary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MitreTacticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Cloud Guard supported MITRE ATT@CK framework tactics. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/MitreTacticSummary' /mitreTactics/{mitreTacticId}/mitreTechniques: get: description: 'Returns a list of MITRE ATT@CK framework techniques associated with a tactic. ' operationId: ListMitreTechniques parameters: - $ref: '#/components/parameters/MitreTacticIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of techniques summary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MitreTechniqueCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of MITRE ATT@CK framework techniques associated with a tactic. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/MitreTechniqueSummary' /monitoringResources: get: description: Returns the list of monitoring resources. operationId: ListMonitoringResources parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetResourceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of monitoring resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MonitoringResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the list of monitoring resources. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/MonitoringResourceSummary' /policies: get: description: 'Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard. ' operationId: ListPolicies parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of global policy statements headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard. tags: - cloudGuard x-related-resource: '#/definitions/PolicySummary' /problems: get: description: 'Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria. The ListProblems operation returns only the problems in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListProblems parameters: - $ref: '#/components/parameters/TimeLastDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeLastDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/ProblemLifecycleDetailsQueryParam' - $ref: '#/components/parameters/ProblemLifecycleStatesQueryParam' - $ref: '#/components/parameters/RegionQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RiskLevelQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/CityQueryParam' - $ref: '#/components/parameters/StateQueryParam' - $ref: '#/components/parameters/CountryQueryParam' - $ref: '#/components/parameters/LabelQueryParam' - $ref: '#/components/parameters/DetectorRuleIdListQueryParam' - $ref: '#/components/parameters/DetectorTypeQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/ProblemCategoryQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByProblemQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ProblemCollection resource with a page of ProblemSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of all problems identified by Cloud Guard which are currently in the database and meet the filtering criteria. tags: - cloudGuard x-related-resource: '#/definitions/Problem' /problems/actions/bulkUpdateStatus: post: description: 'Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails. ' operationId: UpdateBulkProblemStatus parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails. tags: - cloudGuard x-related-resource: '#/definitions/Problem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBulkProblemStatusDetails' description: A list of Problem IDs to be passed in to update the Problem status required: true /problems/actions/summarize: post: description: 'Returns the number of problems matching the key-value pairs in dimensionMap. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: RequestSummarizedProblems parameters: - $ref: '#/components/parameters/ListDimensionsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ProblemAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the number of problems matching the key-value pairs in dimensionMap. tags: - cloudGuard x-related-resource: '#/definitions/ProblemAggregation' /problems/actions/summarizeActivityProblems: post: description: 'Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. The compartmentId to be passed with `accessLevel` and `compartmentIdInSubtree` params has to be the root compartment id (tenant-id) only. ' operationId: RequestSummarizedActivityProblems parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/IncludeUnknownLocationsQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ActivityProblemAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ActivityProblemAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified. tags: - cloudGuard x-related-resource: '#/definitions/ActivityProblemAggregation' /problems/actions/summarizeTrend: post: description: 'Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: RequestSummarizedTrendProblems parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ProblemAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources. tags: - cloudGuard x-related-resource: '#/definitions/ProblemTrendAggregation' /problems/{problemId}: get: description: Returns the Problem resource identified by problemId. operationId: GetProblem parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Problem resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Problem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the Problem resource identified by problemId. tags: - cloudGuard /problems/{problemId}/actions/triggerResponder: post: description: 'Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed. ' operationId: TriggerResponder parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed. ' tags: - cloudGuard x-related-resource: '#/definitions/Problem' requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerResponderDetails' description: The responder may update the problem required: true /problems/{problemId}/actions/updateStatus: post: description: 'Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass. ' operationId: UpdateProblemStatus parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Problem is updated headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Problem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass. tags: - cloudGuard x-related-resource: '#/definitions/Problem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProblemStatusDetails' description: The additional details for the problem required: true /problems/{problemId}/endpoints: get: description: 'Returns a list of endpoints associated with a problem, identified by problemId. ' operationId: ListProblemEndpoints parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ProblemEndpointCollection resource with a page of ProblemEndpointSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of endpoints associated with a problem, identified by problemId. tags: - cloudGuard x-related-resource: '#/definitions/ProblemEndpointSummary' /problems/{problemId}/entities: get: description: 'Returns a list of entities for a problem. ' operationId: ListProblemEntities parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ProblemEntityCollection resource with a page of ProblemEntitySummary resource headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemEntityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of entities for a problem. tags: - cloudGuard x-related-resource: '#/definitions/Problem' /problems/{problemId}/histories: get: description: 'Returns a list of actions taken on a problem. ' operationId: ListProblemHistories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ProblemHistoryCollection resource with a page of ProblemHistorySummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProblemHistoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of actions taken on a problem. tags: - cloudGuard x-related-resource: '#/definitions/Problem' /problems/{problemId}/impactedResources: get: description: 'Returns a list of impacted resources for a problem identified by problemId. ' operationId: ListImpactedResources parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ImpactedResourceCollection resource with a page of ImpactedResourceSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImpactedResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of impacted resources for a problem identified by problemId. tags: - cloudGuard x-related-resource: '#/definitions/ImpactedResourceSummary' /problems/{problemId}/responderActivities: get: description: 'Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources. ' operationId: ListResponderActivities parameters: - $ref: '#/components/parameters/ProblemIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResponderActivitySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderActivityCollection resource with a page of ResponderActivitySummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderActivityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderActivitySummary' /recommendations: get: description: 'Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID. ' operationId: ListRecommendations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByRecommendationQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/RecommendationLifecycleDetailQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: RecommendationSummaryCollection resource with a page of RecommendationSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecommendationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID. ' tags: - cloudGuard x-related-resource: '#/definitions/RecommendationSummary' /resourceProfileRiskScores/actions/summarizeTopTrends: post: description: 'Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment. ' operationId: RequestSummarizedTopTrendResourceProfileRiskScores parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TimeScoreComputedGreaterThanOrEqualTo' - $ref: '#/components/parameters/TimeScoreComputedLessThanOrEqualTo' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ResourceProfileTrendLineSortByQueryParam' - $ref: '#/components/parameters/CountQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceProfileRiskScoreAggregationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceProfileRiskScoreAggregationSummary' /resourceProfiles: get: description: 'Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified. The ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListResourceProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListResourceProfiles parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TimeLastDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeLastDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeFirstDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/ResourceTypeListQueryParam' - $ref: '#/components/parameters/RiskScoreGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/RiskScoreLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TechniqueListQueryParam' - $ref: '#/components/parameters/TacticListQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResourceProfileSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResourceProfileCollection resource with a page of ResourceProfileSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceProfileCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceProfileSummary' /resourceProfiles/{resourceProfileId}: get: description: Returns details for a resource profile, identified by resourceProfileId. operationId: GetResourceProfile parameters: - $ref: '#/components/parameters/ResourceProfileIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Resource profile headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceProfile' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns details for a resource profile, identified by resourceProfileId. tags: - cloudGuard /resourceProfiles/{resourceProfileId}/endpoints: get: description: 'Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId. ' operationId: ListResourceProfileEndpoints parameters: - $ref: '#/components/parameters/ResourceProfileIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceProfileEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceProfileEndpointSummary' /resourceProfiles/{resourceProfileId}/impactedResources: get: description: 'Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId. ' operationId: ListResourceProfileImpactedResources parameters: - $ref: '#/components/parameters/ResourceProfileIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceProfileImpactedResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceProfileImpactedResourceSummary' /resourceRiskScores/actions/summarizeTrend: post: description: 'Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource. ' operationId: RequestSummarizedTrendResourceRiskScores parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TimeScoreComputedGreaterThanOrEqualTo' - $ref: '#/components/parameters/TimeScoreComputedLessThanOrEqualTo' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResourceRiskScoreAggregationCollection resource with a page of ResourceRiskScoreAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceRiskScoreAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceRiskScoreAggregation' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestSummarizedTrendResourceRiskScoresDetails' description: The filter to fetch risk score trend required: true /resourceTypes: get: description: 'Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified. ' operationId: ListResourceTypes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DetectorIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of ResourceTypeCollection resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourceTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified. ' tags: - cloudGuard x-related-resource: '#/definitions/ResourceTypeSummary' /responderExecutions: get: description: 'Returns a list of responder executions. A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem. ' operationId: ListResponderExecutions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/ResponderRuleIdsQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/ResponderExecutionTimeCompletedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/ResponderExecutionTimeCompletedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/ResponderTypeQueryParam' - $ref: '#/components/parameters/ResponderExecutionStatusQueryParam' - $ref: '#/components/parameters/ResponderExecutionModeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResponderExecutionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ResponderExecution resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderExecutionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of responder executions. A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecutionSummary' /responderExecutions/actions/bulkSkip: post: description: Skips the execution for a bulk of responder executions. operationId: SkipBulkResponderExecution parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Skips the execution for a bulk of responder executions. tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecution' requestBody: content: application/json: schema: $ref: '#/components/schemas/SkipBulkResponderExecutionDetails' description: A list of responder execution IDs to skip the execution required: true /responderExecutions/actions/summarize: post: description: 'Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources. Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). “Not Authorized” is returned if user doesn''t have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true. Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). “Not Authorized” is returned if user doesn''t have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true. ' operationId: RequestSummarizedResponderExecutions parameters: - $ref: '#/components/parameters/ResponderExecutionsDimensionsQueryParam' - $ref: '#/components/parameters/ResponderTypeFilterQueryParam' - $ref: '#/components/parameters/ResponderExecutionStatusFilterQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ResponderExecutionAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderExecutionAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecutionAggregation' /responderExecutions/actions/summarizeTrend: post: description: 'Returns the number of remediations performed by Responders, for a given time period. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: RequestSummarizedTrendResponderExecutions parameters: - $ref: '#/components/parameters/ResponderExecutionTimeCompletedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/ResponderExecutionTimeCompletedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'A page of ResponderExecutionTrendAggregation resources The `dimensionsMap` will be always empty for now. We shall add some dimensions later when we need. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderExecutionTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns the number of remediations performed by Responders, for a given time period. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecutionTrendAggregation' /responderExecutions/{responderExecutionId}: get: description: 'Returns a responder execution identified by responderExecutionId. ' operationId: GetResponderExecution parameters: - $ref: '#/components/parameters/ResponderExecutionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderExecution resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderExecution' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a responder execution identified by responderExecutionId. tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecution' /responderExecutions/{responderExecutionId}/actions/execute: post: description: 'Executes the responder execution. When provided, if-match is checked against etag values of the resource. ' operationId: ExecuteResponderExecution parameters: - $ref: '#/components/parameters/ResponderExecutionIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Executes the responder execution. When provided, if-match is checked against etag values of the resource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecution' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExecuteResponderExecutionDetails' description: Details for responder configuration /responderExecutions/{responderExecutionId}/actions/skip: post: description: Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource. operationId: SkipResponderExecution parameters: - $ref: '#/components/parameters/ResponderExecutionIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource. tags: - cloudGuard x-related-resource: '#/definitions/ResponderExecution' /responderRecipes: get: description: 'Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId. The ListResponderRecipe operation returns only the targets in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListResponderRecipes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceMetadataOnlyQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderRecipeCollection resource with page of ResponderRecipeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' post: description: 'Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource. ' operationId: CreateResponderRecipe parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResponderRecipeDetails' description: Details for ResponderRecipe required: true /responderRecipes/{responderRecipeId}: delete: description: Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId. operationId: DeleteResponderRecipe parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId. tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' get: description: Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId. operationId: GetResponderRecipe parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The ResponderRecipe resource with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId. tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' put: description: 'Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource. ' operationId: UpdateResponderRecipe parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated ResponderRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResponderRecipeDetails' description: The details to be updated required: true /responderRecipes/{responderRecipeId}/actions/changeCompartment: post: description: 'Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource. ' operationId: ChangeResponderRecipeCompartment parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeResponderRecipeCompartmentDetails' description: The target compartment OCID required: true /responderRecipes/{responderRecipeId}/responderRules: get: description: 'Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId. ' operationId: ListResponderRecipeResponderRules parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderRecipeResponderRuleCollection resource with page of ResponderRuleSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipeResponderRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipeResponderRule' /responderRecipes/{responderRecipeId}/responderRules/{responderRuleId}: get: description: Returns a responder rule (ResponderRule resource) identified by responderRuleId. operationId: GetResponderRecipeResponderRule parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/ResponderRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Specified ResponderRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipeResponderRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a responder rule (ResponderRule resource) identified by responderRuleId. tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipeResponderRule' put: description: 'Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource. ' operationId: UpdateResponderRecipeResponderRule parameters: - $ref: '#/components/parameters/ResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/ResponderRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated ResponderRule resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRecipeResponderRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRecipeResponderRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResponderRecipeResponderRuleDetails' description: The details to be updated for responder rule required: true /responderRules: get: description: 'Returns a list of responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources. ' operationId: ListResponderRules parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderRuleCollection resource with page of ResponderRuleSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/ResponderRule' /responderRules/{responderRuleId}: get: description: Returns a responder rule (ResponderRule resource) identified by resonderRuleId. operationId: GetResponderRule parameters: - $ref: '#/components/parameters/ResponderRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the responder rule with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponderRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a responder rule (ResponderRule resource) identified by resonderRuleId. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/ResponderRule' /riskScores: post: description: 'Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId. ' operationId: RequestRiskScores parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RiskScoreAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RiskScoreAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/RiskScoreAggregation' /securityPolicies: get: description: 'Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId. ' operationId: ListSecurityPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned a page of `SecurityPolicySummary` resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityPolicyCollection' /securityPolicies/{securityPolicyId}: get: description: 'Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked. ' operationId: GetSecurityPolicy parameters: - $ref: '#/components/parameters/SecurityPolicyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the `SecurityPolicy` resource with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked. ' tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false /securityRecipes: get: description: 'Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId. ' operationId: ListSecurityRecipes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityRecipeIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned a page of `SecurityRecipeSummary` resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRecipeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityRecipeCollection' post: description: 'Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource. ' operationId: CreateSecurityRecipe parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully created the `SecurityRecipe` resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityRecipeDetails' description: Details for the new `SecurityRecipe` resource required: true /securityRecipes/{securityRecipeId}: delete: description: Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone. operationId: DeleteSecurityRecipe parameters: - $ref: '#/components/parameters/SecurityRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the `SecurityRecipe` resource headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone. tags: - cloudGuard x-related-resource: '#/definitions/SecurityRecipe' get: description: Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId. operationId: GetSecurityRecipe parameters: - $ref: '#/components/parameters/SecurityRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the `SecurityRecipe` with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId. tags: - cloudGuard x-obmcs-authz-declarations: authorizationRequired: false put: description: 'Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource. ' operationId: UpdateSecurityRecipe parameters: - $ref: '#/components/parameters/SecurityRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully updated the `SecurityRecipe` headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityRecipeDetails' description: The information to be updated in the security zone recipe required: true /securityRecipes/{securityRecipeId}/actions/changeCompartment: post: description: 'Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment. When provided, `if-match` is checked against `etag` values of the resource. ' operationId: ChangeSecurityRecipeCompartment parameters: - $ref: '#/components/parameters/SecurityRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Successfully moved the `SecurityRecipe` resource to the compartment headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: 'Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment. When provided, `if-match` is checked against `etag` values of the resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityRecipeCompartmentDetails' description: The compartment to which you want to move the `SecurityRecipe` resource required: true /securityScores: post: description: 'Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected. ' operationId: RequestSecurityScores parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of SecurityScoreAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityScoreAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityScoreAggregation' /securityScores/actions/summarizeTrend: post: description: 'Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected. ' operationId: RequestSecurityScoreSummarizedTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TimeScoreComputedGreaterThanOrEqualTo' - $ref: '#/components/parameters/TimeScoreComputedLessThanOrEqualTo' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of SecurityScoreTrendAggregation resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityScoreTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityScoreTrendAggregation' /securityZones: get: description: 'Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources. ' operationId: ListSecurityZones parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityZoneIdentifierQueryParam' - $ref: '#/components/parameters/SecurityZoneRecipeIdentifierQueryParam' - $ref: '#/components/parameters/IsRequiredSecurityZonesInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `SecurityZoneSummary` resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZoneCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZoneCollection' post: description: 'Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource. ' operationId: CreateSecurityZone parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully created the `SecurityZone` resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZone' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityZoneDetails' description: Details for the new `SecurityZone` resource required: true /securityZones/{securityZoneId}: delete: description: Deletes a security zone, identified by securityZoneId. operationId: DeleteSecurityZone parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the `SecurityZone` resource headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a security zone, identified by securityZoneId. tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' get: description: Returns a security zone (SecurityZone resource) identified by securityZoneId. operationId: GetSecurityZone parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the `SecurityZone` with the specified ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZone' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a security zone (SecurityZone resource) identified by securityZoneId. tags: - cloudGuard put: description: 'Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource. ' operationId: UpdateSecurityZone parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully updated the `SecurityZone` resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZone' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityZoneDetails' description: The security zone information to be updated required: true /securityZones/{securityZoneId}/actions/addCompartment: post: description: 'Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone''s policies. ' operationId: AddCompartment parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully added the compartment to the security zone headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZone' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: 'Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone''s policies. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddCompartmentDetails' description: Parameters for an existing compartment to be added to a security zone required: true /securityZones/{securityZoneId}/actions/changeCompartment: post: description: 'Moves a security zone, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, `if-match` is checked against `etag` values of the resource. ' operationId: ChangeSecurityZoneCompartment parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Successfully moved the `SecurityZone` resource to a different compartment headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: 'Moves a security zone, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, `if-match` is checked against `etag` values of the resource. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityZoneCompartmentDetails' description: The compartment to which you want to move the security zone required: true /securityZones/{securityZoneId}/actions/removeCompartment: post: description: 'Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can''t remove the primary compartment that was used to create the security zone. ' operationId: RemoveCompartment parameters: - $ref: '#/components/parameters/SecurityZoneIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully removed the compartment from the security zone headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityZone' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: 'Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can''t remove the primary compartment that was used to create the security zone. ' tags: - cloudGuard x-related-resource: '#/definitions/SecurityZone' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveCompartmentDetails' description: The compartment to remove from the security zone required: true /sightings: get: description: 'For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSightings on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListSightings parameters: - $ref: '#/components/parameters/ProblemIdQueryParam' - $ref: '#/components/parameters/ResourceProfileIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/TimeLastDetectedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeLastDetectedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SightingCollection resource with a page of SightingSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SightingCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/SightingSummary' /sightings/{sightingId}: get: description: Returns a single sighting (Sighting resource) identified by sightingId. operationId: GetSighting parameters: - $ref: '#/components/parameters/SightingIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sighting resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Sighting' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a single sighting (Sighting resource) identified by sightingId. tags: - cloudGuard put: description: Updates a sighting. operationId: UpdateSighting parameters: - $ref: '#/components/parameters/SightingIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Updated sighting headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Sighting' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a sighting. tags: - cloudGuard x-related-resource: '#/definitions/Sighting' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSightingDetails' description: The classification status of the sighting required: true /sightings/{sightingId}/additionalEntities: get: description: Returns a list of associated additional entities for a Cloud Guard sighting operationId: ListSightingAdditionalEntities parameters: - $ref: '#/components/parameters/SightingIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SightingAdditionalEntityCollection resource with a page of SightingAdditionalEntitySummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SightingAdditionalEntityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of associated additional entities for a Cloud Guard sighting tags: - cloudGuard x-related-resource: '#/definitions/Sighting' /sightings/{sightingId}/endpoints: get: description: 'Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources. ' operationId: ListSightingEndpoints parameters: - $ref: '#/components/parameters/SightingIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SightingEndpointsCollection resource with a page of SightingEndpointSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SightingEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/SightingEndpointSummary' /sightings/{sightingId}/impactedResources: get: description: 'Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources. ' operationId: ListSightingImpactedResources parameters: - $ref: '#/components/parameters/SightingIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByDefaultQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SightingImpactedResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/SightingImpactedResourceSummary' /tactics: get: description: Returns a list of TacticSummary resources for a compartment, identified by compartmentId. operationId: ListTactics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MetadataSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of TacticSummary resources. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TacticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of TacticSummary resources for a compartment, identified by compartmentId. tags: - cloudGuard x-related-resource: '#/definitions/TacticSummary' /targets: get: description: 'Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn''t have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListTargets on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all targets in compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListTargets parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IsNonSecurityZoneTargetsOnlyQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetCollection resource with page of TargetSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of targets (TargetCollection resources with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments. ' tags: - cloudGuard x-related-resource: '#/definitions/Target' post: description: 'Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource. ' operationId: CreateTarget parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Target resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Target' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/Target' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTargetDetails' description: Contains generic target information which is required for all target types required: true /targets/{targetId}: delete: description: Deletes a target (Target resource) identified by targetId. operationId: DeleteTarget parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a target (Target resource) identified by targetId. tags: - cloudGuard x-related-resource: '#/definitions/Target' get: description: Returns a target (Target resource) identified by targetId. operationId: GetTarget parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Target resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Target' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a target (Target resource) identified by targetId. tags: - cloudGuard x-related-resource: '#/definitions/Target' put: description: 'Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource. ' operationId: UpdateTarget parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated Target resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Target' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/Target' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetDetails' description: The information to be updated required: true /targets/{targetId}/monitoringSignals: get: description: 'Returns a list of target monitoring signals for a compartment identified by compartmentId and a target identified by targetId. Some values are passed in a ListTargetMonitoringSignalsList resource. ' operationId: ListTargetMonitoringSignals parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ScanStatusQueryParam' - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: TargetMonitoringSignal resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetMonitoringSignalCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of target monitoring signals for a compartment identified by compartmentId and a target identified by targetId. Some values are passed in a ListTargetMonitoringSignalsList resource. List is returned in a TargetMonitoringSignal resource. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetMonitoringSignalSummary' /targets/{targetId}/targetDetectorRecipes: get: description: 'Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources. ' operationId: ListTargetDetectorRecipes parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipe' post: description: 'Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target ' operationId: CreateTargetDetectorRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Target DetectorRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. ' tags: - cloudGuard requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachTargetDetectorRecipeDetails' description: Details for associating DetectorRecipe with Target required: true /targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}: delete: description: 'Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId. ' operationId: DeleteTargetDetectorRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipe' get: description: Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId. operationId: GetTargetDetectorRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetDetectorRecipe with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId. tags: - cloudGuard put: description: 'Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource. ' operationId: UpdateTargetDetectorRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated DetectorRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetDetectorRecipeDetails' description: The details to be updated required: true /targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules: get: description: 'Returns a list of DetectorRule associated with DetectorRecipe within a Target. ' operationId: ListTargetDetectorRecipeDetectorRules parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'TargetDetectorRecipeDetectorRuleCollection resource with page of TargetDetectorRecipeDetectorRule resources ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of DetectorRule associated with DetectorRecipe within a Target. tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipeDetectorRule' /targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules/{detectorRuleId}: get: description: Returns DetectorRule resource by identified by targetDetectorRecipeId. operationId: GetTargetDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/DetectorRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: DetectorRule resource in DetectorRecipe resource attched to target headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns DetectorRule resource by identified by targetDetectorRecipeId. tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipeDetectorRule' put: description: Updates the DetectorRule resource identified by targetDetectorRecipeId operationId: UpdateTargetDetectorRecipeDetectorRule parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetDetectorRecipeIdentifierPathParam' - $ref: '#/components/parameters/DetectorRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated DetectorRule resource associated with the DetectorRecipe resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the DetectorRule resource identified by targetDetectorRecipeId tags: - cloudGuard x-related-resource: '#/definitions/TargetDetectorRecipeDetectorRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetDetectorRecipeDetectorRuleDetails' description: The details to be updated for the detector rule required: true /targets/{targetId}/targetResponderRecipes: get: description: 'Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId. ' operationId: ListTargetResponderRecipes parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetResponderRecipeCollection resource with page of TargetResponderRecipeSummary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipe' post: description: 'Attaches a responder recipe to a target. ' operationId: CreateTargetResponderRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetResponderRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches a responder recipe to a target. tags: - cloudGuard requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachTargetResponderRecipeDetails' description: Details for attaching a responder recipe to a target required: true /targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}: delete: description: 'Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId. ' operationId: DeleteTargetResponderRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipe' get: description: 'Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId. ' operationId: GetTargetResponderRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: TargetResponderRecipe resource with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a target responder recipe (TargetResponderRecipe resource), identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. ' tags: - cloudGuard put: description: 'Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource. ' operationId: UpdateTargetResponderRecipe parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated ResponderRecipe resource headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetResponderRecipeDetails' description: The details to be updated required: true /targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules: get: description: 'Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources. ' operationId: ListTargetResponderRecipeResponderRules parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByStaticDataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipeResponderRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipeResponderRule' /targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules/{responderRuleId}: get: description: 'Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId. ' operationId: GetTargetResponderRecipeResponderRule parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/ResponderRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ResponderRule resource within the responder recipe that's attached to the target headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipeResponderRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipeResponderRule' put: description: 'Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource. ' operationId: UpdateTargetResponderRecipeResponderRule parameters: - $ref: '#/components/parameters/TargetIdentifierPathParam' - $ref: '#/components/parameters/TargetResponderRecipeIdentifierPathParam' - $ref: '#/components/parameters/ResponderRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated ResponderRule resource associated with ResponderRecipe resource attached to the target. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetResponderRecipeResponderRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource. ' tags: - cloudGuard x-related-resource: '#/definitions/TargetResponderRecipeResponderRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetResponderRecipeResponderRuleDetails' description: The details to be updated for the ResponderRule resource. required: true /techniques: get: description: 'Returns a list of techniques associated with detector rules. ' operationId: ListTechniques parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TacticListQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MetadataSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of techniques summary resources headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TechniqueCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of techniques associated with detector rules. tags: - cloudGuard x-related-resource: '#/definitions/TechniqueSummary' /workRequests: get: description: 'Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work request summaries headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId. ' tags: - cloudGuard x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels a work request identified by workRequestId. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels a work request identified by workRequestId. tags: - cloudGuard x-related-resource: '#/definitions/WorkRequest' get: description: Returns details for a work request (WorkRequest resource) identified by workRequestId. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of the work reques headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns details for a work request (WorkRequest resource) identified by workRequestId. tags: - cloudGuard x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: "Returns a list of errors for a work request \nidentified by workRequestId.\n" operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: "Returns a list of errors for a work request \nidentified by workRequestId.\n" tags: - cloudGuard x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId. ' tags: - cloudGuard x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: DetectorRuleIdQueryParam: description: The unique identifier of a detector rule. in: query name: detectorRuleId schema: type: string maxLength: 255 minLength: 1 SightingIdPathParam: description: OCID of the sighting. in: path name: sightingId required: true schema: type: string SecurityPolicyIdentifierPathParam: description: The unique identifier of the security zone policy. (`SecurityPolicy`) in: path name: securityPolicyId required: true schema: type: string ResponderExecutionIdentifierPathParam: description: The unique identifier of the responder execution. in: path name: responderExecutionId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false x-default-description: 'null' schema: type: string ResponderExecutionTimeCompletedGreaterThanOrEqualToQueryParam: description: Completion end time. in: query name: timeCompletedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time DataMaskRuleStatusQueryParam: description: The status of the data mask rule in: query name: dataMaskRuleStatus required: false x-obmcs-top-level-enum: '#/definitions/DataMaskRuleStatus' schema: type: string enum: - ENABLED - DISABLED default: ENABLED ListDimensionsQueryParam: description: The possible attributes based on which the problems can be distinguished. in: query name: listDimensions required: true style: form explode: true schema: type: array items: enum: - RESOURCE_TYPE - REGION - COMPARTMENT_ID - RISK_LEVEL - DETECTOR_ID - TARGET_ID type: string x-obmcs-top-level-enum: '#/definitions/ProblemDimension' maxItems: 2 minItems: 1 uniqueItems: true LifecycleStateQueryParam: description: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED default: ACTIVE ResponderExecutionStatusFilterQueryParam: description: 'The possible filters for responder type dimension to distinguish responder executions. If no values are passed, the metric for responder executions of all status are returned. ' in: query name: responderExecutionStatusFilter required: false style: form explode: true schema: type: array items: enum: - STARTED - AWAITING_CONFIRMATION - SUCCEEDED - FAILED - SKIPPED type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionStatus' default: [] maxItems: 5 minItems: 1 uniqueItems: true MitreTacticIdPathParam: description: Unique identifier of the MITRE ATT@CK framework tactic. in: path name: mitreTacticId required: true schema: type: string RiskScoreGreaterThanOrEqualToQueryParam: description: Risk score filter. in: query name: riskScoreGreaterThanOrEqualTo x-default-description: 'null' schema: type: number format: double ListTypeQueryParam: description: The type of managed list. in: query name: listType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ManagedListType' schema: type: string enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR ResourceMetadataOnlyQueryParam: description: 'Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned. ' in: query name: resourceMetadataOnly required: false schema: type: boolean default: false DetectorRuleIdListQueryParam: description: Comma seperated list of detector rule IDs to be passed in to match against Problems. in: query name: detectorRuleIdList x-default-description: A list of detector rule ids to be passed in to match against Problems. style: form explode: true schema: type: array items: type: string default: [] maxItems: 100 minItems: 0 uniqueItems: true TimeCreatedLessThanOrEqualToQueryParam: description: Creation end time for filtering. in: query name: timeCreatedLessThanOrEqualTo x-default-description: all Responder executions will be returned schema: type: string format: date-time DataSourceIdPathParam: description: Data source OCID. in: path name: dataSourceId required: true schema: type: string RiskLevelQueryParam: description: Risk level of the problem. in: query name: riskLevel x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ConditionResourceTypeQueryParam: description: Resource filter for the condition metadata. in: query name: resourceType required: false x-default-description: Default value schema: type: string DataMaskRuleIAMGroupIdQueryParam: description: OCID of the IAM group in: query name: iamGroupId required: false schema: type: string default: 'null' ResponderRuleIdsQueryParam: description: Responder rule unique identifier filter for the responder executions. in: query name: responderRuleIds required: false x-default-description: If no value is passed then executions for all responder rule ids are returned style: form explode: true schema: type: array items: type: string default: [] maxItems: 100 minItems: 0 uniqueItems: true LabelQueryParam: description: User-defined label associated with the problem. in: query name: label x-default-description: User Defined Label associated with the Problem. schema: type: string maxLength: 255 minLength: 1 ResponderExecutionModeQueryParam: description: The mode of the responder execution in which to list responders. in: query name: responderExecutionMode x-obmcs-top-level-enum: '#/definitions/ResponderExecutionModes' schema: type: string enum: - MANUAL - AUTOMATED - ALL default: ALL ResponderExecutionSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - responderRuleName - resourceName - timeCompleted default: timeCreated ResponderExecutionTimeCompletedLessThanOrEqualToQueryParam: description: Completion start time. in: query name: timeCompletedLessThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time WorkRequestSortByQueryParam: description: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted CompartmentIdInSubtreeQueryParam: description: 'Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of `accessLevel`. ' in: query name: compartmentIdInSubtree required: false schema: type: boolean default: false ResourceTypeQueryParam: description: Resource type associated with the resource. in: query name: resourceType x-default-description: Resource Type associated with the resource. schema: type: string maxLength: 255 minLength: 1 SortByProblemQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default. ' in: query name: sortBy schema: type: string enum: - riskLevel - timeLastDetected - resourceName default: timeLastDetected PaginationLimitQueryParam: description: The maximum number of items to return in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 ResourceIdQueryParam: description: The ID of the resource associated with the problem. in: query name: resourceId x-default-description: 'null' schema: type: string CountryQueryParam: description: Country of the problem. in: query name: country x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ResponderExecutionsDimensionsQueryParam: description: The possible attributes based on which the responder executions can be distinguished. in: query name: responderExecutionsDimensions required: true style: form explode: true schema: type: array items: enum: - RESPONDER_RULE_TYPE - RESPONDER_EXECUTION_STATUS type: string x-obmcs-top-level-enum: '#/definitions/ResponderDimension' maxItems: 2 minItems: 1 uniqueItems: true StateQueryParam: description: State or province of the problem. in: query name: state x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 TimeLastDetectedGreaterThanOrEqualToQueryParam: description: Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. in: query name: timeLastDetectedGreaterThanOrEqualTo x-default-description: set the start time for date range schema: type: string format: date-time ResponderRecipeIdentifierPathParam: description: OCID of the responder recipe. in: path name: responderRecipeId required: true schema: type: string SortOrderQueryParam: description: The sort order to use in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC TargetResourceTypeQueryParam: description: Target resource type in: query name: targetResourceType x-obmcs-top-level-enum: '#/definitions/TargetResourceType' schema: type: string enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE default: COMPARTMENT ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId schema: type: string SortByStaticDataQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. ' in: query name: sortBy schema: type: string enum: - displayName - riskLevel default: displayName DetectorRecipeIdPathParam: description: Detector recipe OCID in: path name: detectorRecipeId required: true schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given operation status (OperationStatus resource). in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string DetectorTypeQueryParam: description: 'The field to list the problems by detector type. ' in: query name: detectorType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DetectorEnum' schema: type: string enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR MetadataSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. ' in: query name: sortBy schema: type: string enum: - displayName default: displayName RegionQueryParam: description: OCI monitoring region. in: query name: region x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SortByDefaultQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated DataMaskRuleIdentifierPathParam: description: OCID of the data mask rule in: path name: dataMaskRuleId required: true schema: type: string ScanStatusQueryParam: description: The field scan status. Only one status can be provided. Default value for scan status is failed. If no value is specified scan status is failed. in: query name: scanStatus x-obmcs-top-level-enum: '#/definitions/ScanStatus' schema: type: string enum: - SUCCEEDED - FAILED default: FAILED IncludeUnknownLocationsQueryParam: description: 'Default is false. When set to true, the summary of activity problems that has unknown values for city, state or country will be included. ' in: query name: includeUnknownLocations required: false schema: type: boolean default: false ConditionMetadataTypePathParam: description: The type of the condition metadata. in: path name: conditionMetadataTypeId required: true x-default-description: ActivityCondition x-obmcs-top-level-enum: '#/definitions/ConditionTypeEnum' schema: type: string enum: - ActivityCondition - SecurityCondition - CloudGuardCondition - ThreatCondition - FaActivityCondition - ContainerCondition TargetIdQueryParam: description: The ID of the target in which to list resources. in: query name: targetId x-default-description: 'null' schema: type: string TargetResponderRecipeIdentifierPathParam: description: OCID of the target responder recipe. in: path name: targetResponderRecipeId required: true schema: type: string TimeFirstDetectedLessThanOrEqualToQueryParam: description: End time for a filter. If end time is not specified, end time will be set to current time. in: query name: timeFirstDetectedLessThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time TimeFirstDetectedGreaterThanOrEqualToQueryParam: description: Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. in: query name: timeFirstDetectedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time ResponderRuleIdentifierPathParam: description: Unique identifier of the responder rule. in: path name: responderRuleId required: true schema: type: string SecurityRecipeIdentifierPathParam: description: The unique identifier of the security zone recipe. (`SecurityRecipe`) in: path name: securityRecipeId required: true schema: type: string CompartmentIdQueryParam: description: The OCID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string WorkRequestLogErrorSortByQueryParam: description: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated SecurityRecipeIdentifierQueryParam: description: The unique identifier of the security zone recipe. (`SecurityRecipe`) in: query name: id x-default-description: 'null' schema: type: string TargetIdentifierPathParam: description: OCID of the target in: path name: targetId required: true schema: type: string ResourceProfileIdQueryParam: description: OCID of the resource profile. in: query name: resourceProfileId schema: type: string RegionIdentifierQueryParam: description: A filter to return only resource where their region matches the given region. in: query name: region x-default-description: 'null' schema: type: string ProblemLifecycleDetailsQueryParam: description: The field life cycle state. Only one state can be provided. Default value for state is active. in: query name: lifecycleDetail x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' schema: type: string enum: - OPEN - RESOLVED - DISMISSED - DELETED default: OPEN TechniqueListQueryParam: description: A filter to return only resources that match the list of techniques given. in: query name: techniques x-default-description: 'null' style: form explode: true schema: type: array items: type: string default: [] maxItems: 100 minItems: 0 uniqueItems: true SecurityZoneRecipeIdentifierQueryParam: description: The unique identifier of the security zone recipe. (`SecurityRecipe` resource). in: query name: securityRecipeId x-default-description: 'null' schema: type: string ResponderActivitySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - responderRuleName default: timeCreated DataSourceFeedProviderQueryParam: description: A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource). in: query name: dataSourceFeedProvider required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' schema: type: string enum: - LOGGINGQUERY RiskScoreLessThanOrEqualToQueryParam: description: Risk score filter, in: query name: riskScoreLessThanOrEqualTo x-default-description: 'null' schema: type: number format: double RuleCategoryQueryParam: description: The field rule category. Only one category can be provided. Default value for category is rule. If no value is specified category is rule. in: query name: ruleCategory x-obmcs-top-level-enum: '#/definitions/RuleCategory' schema: type: string enum: - RULE - TEMPLATE default: RULE TacticListQueryParam: description: A filter to return only resources that match the list of tactics given. in: query name: tactics x-default-description: 'null' style: form explode: true schema: type: array items: type: string default: [] maxItems: 100 minItems: 0 uniqueItems: true SecurityZoneIdentifierPathParam: description: The unique identifier of the security zone (`SecurityZone` resource). in: path name: securityZoneId required: true schema: type: string TimeScoreComputedLessThanOrEqualTo: description: End time for a filter. If end time is not specified, end time will be set to today's current time. in: query name: timeScoreComputedLessThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time DetectorRuleIdentifierPathParam: description: The unique identifier of the detector rule. in: path name: detectorRuleId required: true schema: type: string IsRequiredSecurityZonesInSubtreeQueryParam: description: Is security zones in the subtree? in: query name: isRequiredSecurityZonesInSubtree x-default-description: 'null' schema: type: boolean ManagedListIdPathParam: description: The managed list OCID to be passed in the request. in: path name: managedListId required: true schema: type: string DetectorIdPathParam: description: Detector name. in: path name: detectorId required: true schema: type: string ResourceTypeListQueryParam: description: A filter to return only resources that match the list of resource types given. in: query name: resourceTypes x-default-description: 'null' style: form explode: true schema: type: array items: type: string default: [] maxItems: 100 minItems: 0 uniqueItems: true ResourceProfileTrendLineSortByQueryParam: description: 'The field to sort trendlines for resource profiles. Only one sort order may be provided. If no value is specified riskScore is default. ' in: query name: sortBy schema: type: string enum: - riskScore - riskScoreGrowth - timeFirstDetected - timeLastDetected default: riskScore TargetDetectorRecipeIdentifierPathParam: description: OCID of the target detector recipe. in: path name: targetDetectorRecipeId required: true schema: type: string ProblemIdPathParam: description: OCID of the problem. in: path name: problemId required: true schema: type: string SecurityZoneIdentifierQueryParam: description: The unique identifier of the security zone (`SecurityZone` resource). in: query name: id x-default-description: 'null' schema: type: string ResourceProfileIdPathParam: description: OCID of the resource profile. in: path name: resourceProfileId required: true schema: type: string ProblemCategoryQueryParam: description: 'Setting this to `SECURITY_ZONE` returns only security zone-related violations. ' in: query name: problemCategory x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ProblemCategoryEnum' schema: type: string enum: - SECURITY_ZONE CityQueryParam: description: City of the problem. in: query name: city x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ResponderExecutionStatusQueryParam: description: The status of the responder execution in which to list responders. in: query name: responderExecutionStatus x-obmcs-top-level-enum: '#/definitions/ResponderExecutionStates' schema: type: string enum: - STARTED - AWAITING_CONFIRMATION - AWAITING_INPUT - SUCCEEDED - FAILED - SKIPPED - ALL default: ALL TimeCreatedGreaterThanOrEqualToQueryParam: description: Creation start time for filtering in: query name: timeCreatedGreaterThanOrEqualTo x-default-description: all Responder executions will be returned schema: type: string format: date-time TimeLastDetectedLessThanOrEqualToQueryParam: description: End time for a filter. If end time is not specified, end time will be set to current time. in: query name: timeLastDetectedLessThanOrEqualTo x-default-description: set the start time for date range schema: type: string format: date-time DetectorIdQueryParam: description: Detector type. in: query name: detectorId required: false x-obmcs-top-level-enum: '#/definitions/DetectorEnum' schema: type: string enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR DataMaskRuleTargetTypeQueryParam: description: Type of target in: query name: targetType required: false schema: type: string default: 'null' ConditionServiceTypeQueryParam: description: Service type filter for the condition metadata. in: query name: serviceType required: false x-default-description: Default value schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated AccessLevelQueryParam: description: 'Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. Setting this to `ACCESSIBLE` returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to `RESTRICTED` permissions are checked and no partial results are displayed. ' in: query name: accessLevel schema: type: string enum: - RESTRICTED - ACCESSIBLE default: RESTRICTED DataMaskRuleTargetIdQueryParam: description: OCID of the target in: query name: targetId required: false schema: type: string default: 'null' ResponderTypeFilterQueryParam: description: 'The possible filters for responder type dimension to distinguish responder executions. If no values are passed, the metric for responder executions of all responder types are returned. ' in: query name: responderTypeFilter required: false style: form explode: true schema: type: array items: enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' default: [] maxItems: 2 minItems: 1 uniqueItems: true SightingTypeIdPathParam: description: Unique ID of the sighting type. in: path name: sightingTypeId required: true schema: type: string ProblemLifecycleStatesQueryParam: description: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleState' schema: type: string enum: - ACTIVE - INACTIVE default: ACTIVE ResponderTypeQueryParam: description: 'The field to list the responder executions by responder type. Valid values are REMEDIATION and NOTIFICATION. ' in: query name: responderType x-default-description: 'null' schema: type: string enum: - REMEDIATION - NOTIFICATION RecommendationLifecycleDetailQueryParam: description: The field lifecycle state. Only one state can be provided. Default value for state is active. in: query name: lifecycleDetail x-obmcs-top-level-enum: '#/definitions/RecommendationLifecycleDetail' schema: type: string enum: - OPEN - RESOLVED - DISMISSED default: OPEN DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: 'null' schema: type: string maxLength: 1024 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 DetectorRuleIdPathParam: description: The unique identifier of a detector rule. in: path name: detectorRuleId required: true schema: type: string CountQueryParam: description: 'Number of resource profile risk score trend-lines to be displayed. Default value is 10. ' in: query name: count schema: type: integer default: 10 maximum: 10 minimum: 1 IsNonSecurityZoneTargetsOnlyQueryParam: description: 'Default is false. When set to true, only the targets that would be deleted as part of security zone creation will be returned. ' in: query name: isNonSecurityZoneTargetsOnlyQuery required: false schema: type: boolean default: false ProblemIdQueryParam: description: OCID of the problem. in: query name: problemId schema: type: string TimeScoreComputedGreaterThanOrEqualTo: description: Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days. in: query name: timeScoreComputedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time SecurityPolicyIdentifierQueryParam: description: The unique identifier of the security zone policy. (`SecurityPolicy`) in: query name: id x-default-description: 'null' schema: type: string SortByRecommendationQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for riskLevel and timeCreated is descending. If no value is specified riskLevel is default. ' in: query name: sortBy schema: type: string enum: - riskLevel - timeCreated default: riskLevel LoggingQueryTypeQueryParam: description: A filter to return only resources where their query type matches the given LoggingQueryType. in: query name: loggingQueryType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LoggingQueryType' schema: type: string enum: - INSIGHT - SIGHTING ResourceProfileSortByQueryParam: description: 'The field to sort resource profiles. Only one sort order may be provided. Default order for timeLastDetected is descending. If no value is specified timeLastDetected is default. ' in: query name: sortBy schema: type: string enum: - riskScore - riskScoreGrowth - timeFirstDetected - timeLastDetected - sightingsCount - displayName - type default: timeLastDetected schemas: UpdateTargetDetectorRecipe: description: Parameters to update a detector recipe attached to a target. properties: detectorRules: description: Updates to be applied to detector rules in target detector recipe items: $ref: '#/components/schemas/UpdateTargetRecipeDetectorRuleDetails' type: array targetDetectorRecipeId: description: Unique identifier for target detector recipe maxLength: 255 minLength: 1 type: string required: - targetDetectorRecipeId type: object CreateSecurityRecipeDetails: description: Parameters to be used to create a security recipe. properties: compartmentId: description: The OCID of the compartment in which to create the recipe maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The recipe's description maxLength: 511 minLength: 1 type: string displayName: description: 'The recipe''s display name. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object securityPolicies: description: The list of security policy IDs to include in the recipe items: maxLength: 255 minLength: 1 type: string type: array required: - displayName - securityPolicies - compartmentId type: object SecurityPolicySummary: description: 'Summary information for a Security Zones policy. A security policy defines a security requirement for resources in a security zone. ' properties: category: description: The category of the security policy type: string compartmentId: description: The OCID of the security policy's compartment type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security policy's description type: string displayName: description: The security policy's display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object friendlyName: description: A shorter version of the security policy's name type: string id: description: Unique identifier that can’t be changed after creation type: string lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a policy in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the security policy enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: The owner of the security policy enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' services: description: The list of services that the security policy protects items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the security policy was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The date and time the security policy was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - owner type: object UpdateTargetDetectorRecipeDetectorRuleDetails: description: Parameters to use to update a detector rule in a detector recipe attached to a target. properties: details: $ref: '#/components/schemas/UpdateTargetDetectorRuleDetails' required: - details type: object ResponderRecipe: description: 'A ResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat). A ResponderRecipe resource: * Is effectively a copy of a Responder resource in which users can make very limited changes if it’s Oracle-managed, and more changes if it’s user-managed. * Can also be created by cloning an existing ResponderRecipe resource, either user-managed or Oracle-managed. * Is visible on Cloud Guard’s Responder Recipes page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply globally, to resources in all OCI compartments mapped to a target that attaches the responder recipe, but are overridden by any changes made in the corresponding TargetResponderRecipe resource (effectively created when the responder recipe is attached to the target). ' properties: compartmentId: description: Compartment OCID type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Responder recipe description type: string displayName: description: Responder recipe display name type: string effectiveResponderRules: description: List of currently enabled responder rules for the responder type, for recipe after applying defaults items: $ref: '#/components/schemas/ResponderRecipeResponderRule' type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier for the responder recip maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the example enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: Owner of responder recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' responderRules: description: List of responder rules associated with the recipe items: $ref: '#/components/schemas/ResponderRecipeResponderRule' type: array sourceResponderRecipeId: description: The unique identifier of the source responder recipe type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the responder recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId type: object ActivityProblemAggregationCollection: description: A collection of ProblemAggregation resources for problem analytics. properties: items: description: List of all the ActivityProblemAggregation resources items: $ref: '#/components/schemas/ActivityProblemAggregation' type: array required: - items type: object UpdateDataSourceDetails: description: Parameters to update a data source. properties: dataSourceDetails: $ref: '#/components/schemas/DataSourceDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detailed description of the data source. type: string displayName: description: Display name for data source type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object status: description: Enablement status of data source enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataSourceStatus' type: object DetectorRecipeCollection: description: The collection of summary information for detector recipes. properties: items: description: List of DetectorRecipeSummary resources items: $ref: '#/components/schemas/DetectorRecipeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ValidateCredentialsDetails: description: Collection of credential details to be validated. properties: items: description: List of credential details (CredentialsDetailsItem resources) to validate items: $ref: '#/components/schemas/CredentialsDetailsItem' type: array resourceType: default: COMPARTMENT description: Type of resource enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' required: - resourceType type: object ActivityProblemAggregation: description: Provides the parameters and their corresponding count. properties: count: description: The number of occurrences with given dimensions type: integer dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object geographicalLocation: $ref: '#/components/schemas/GeographicalLocation' politicalLocation: $ref: '#/components/schemas/PoliticalLocation' required: - dimensionsMap - politicalLocation - geographicalLocation - count type: object CreateDetectorRecipeDetectorRuleDetails: description: Parameters to use to create details in a detector rule in a detector recipe. properties: details: $ref: '#/components/schemas/CreateDetectorRuleDetails' type: object ResponderExecutionAggregationCollection: description: Collection of ResponderExecutionAggregation resources. properties: items: description: List of all the ResponderExecutionAggregation resources items: $ref: '#/components/schemas/ResponderExecutionAggregation' type: array required: - items type: object TargetDetails: description: Details specific to the target type. discriminator: propertyName: targetResourceType properties: targetResourceType: description: Target type, determined by the type of resource for which the target was created enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/TargetResourceType' required: - targetResourceType EntityDetails: description: Detailed information for the entities mapped to a data source. properties: displayName: description: The display name of entity type: string type: description: Type of entity type: string value: description: The entity value type: string type: object Condition: description: The base condition resource. discriminator: propertyName: kind properties: kind: description: Type of condition resource enum: - COMPOSITE - SIMPLE type: string required: - kind TechniqueCollection: description: Collection of technique summaries. properties: items: description: List of TechniqueSummary resources items: $ref: '#/components/schemas/TechniqueSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ImpactedResourceSummary: description: Summary of information on a resource that’s been impacted by a detected problem. properties: compartmentId: description: Compartment OCID where the impacted resource is created type: string id: description: Unique identifier for finding event type: string problemId: description: Problem ID associated with the Impacted resource type: string region: description: Region where the resource is created type: string resourceId: description: Unique identifier of the impacted resource type: string resourceName: description: Name of the impacted resource type: string resourceType: description: Type of the impacted resource type: string sightingType: description: Sighting type involved type: string sightingTypeDisplayName: description: Display name of the sighting type type: string timeIdentified: description: Date and time when the problem was identified format: date-time type: string required: - id - resourceId - problemId - resourceName - resourceType - compartmentId - region - timeIdentified type: object OperatorSummary: description: Summary information on available operators. properties: datatype: description: Data type of the operand type: string displayName: description: Display name of the operand type: string filterType: description: Type of filter enum: - CONDITION - CONFIG type: string x-obmcs-top-level-enum: '#/definitions/ConditionFilterType' managedListtype: description: Operand list type type: string multiListTypes: description: Configuration value type list for multi-list data type items: type: string type: array name: description: Name of the operand type: string operators: description: List of parameters items: $ref: '#/components/schemas/ConditionOperator' type: array required: - name - displayName - filterType - operators - datatype - managedListtype type: object SecurityScoreAggregation: description: Provides the dimensions and their corresponding count value. properties: dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object securityRating: description: The security rating with given parameters enum: - EXCELLENT - GOOD - FAIR - POOR - NA type: string x-obmcs-top-level-enum: '#/definitions/SecurityRating' securityScore: description: The security score with given parameters type: integer required: - dimensionsMap - securityRating - securityScore type: object TargetDetectorRecipeDetectorRuleSummary: description: Summary information for a detector rule in a detector recipe. properties: dataSourceId: description: The unique identifier of the attached data source type: string description: description: Detector template description type: string detector: description: Type of detector enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorDetails: $ref: '#/components/schemas/TargetDetectorDetails' displayName: description: Detector template display name type: string entitiesMappings: description: Data source entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array id: description: The unique identifier of the detector rule maxLength: 255 minLength: 1 type: string isCloneable: description: Is the rule cloneable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the target detector recipe rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for TargetDetectorRecipeDetectorRule resource type: string resourceType: description: Resource type of the configuration to which the rule is applied type: string ruleType: description: Rule category type items: $ref: '#/components/schemas/RuleType' type: array serviceType: description: Service type of the configuration to which the rule is applied type: string sourceDetectorRuleId: description: The unique identifier of source detector rule type: string timeCreated: description: The date and time the target detector recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target detector recipe rule was last updated. Format defined by RFC3339. format: date-time type: string required: - id - detector type: object UpdateSecurityZoneDetails: description: Parameters to be used to update a security zone. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security zone's description maxLength: 511 minLength: 1 type: string displayName: description: The security zone's display name maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object isInheritanceAfterDeleteEnabled: description: Indicates if upon deletion of the security zone the comparment should inherit parent security zone type: boolean securityZoneRecipeId: description: The OCID of the security recipe (`SecurityRecipe` resource) for the security zone maxLength: 255 minLength: 1 type: string required: - displayName type: object SightingEndpointSummary: description: A summary of sighting endpoints. properties: asnNumber: description: ASN number of sighting type: string country: description: Country involved in sighting type: string id: description: Unique identifier for sighting endpoints type: string ipAddress: description: IP address involved in sighting type: string ipAddressType: description: Type of IP address involved in sighting type: string ipClassificationType: description: IP address classification type type: string latitude: description: Latitude of sighting format: double type: number longitude: description: Longitude of sighting format: double type: number problemId: description: Problem ID for sighting endpoints type: string regions: description: List of regions where activities were performed from this IP address items: type: string type: array uniqueItems: true services: description: List of services where activities were performed from this IP address items: type: string type: array sightingId: description: Sighting ID for sighting endpoints type: string timeFirstDetected: description: Time the activities were first detected. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. format: date-time type: string timeLastDetected: description: Time the activities were last detected. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. format: date-time type: string required: - id - sightingId - timeLastDetected - ipAddress - ipAddressType type: object ResponderRecipeResponderRuleCollection: description: The collection of responder rule summaries for a responder recipe. properties: items: description: List of ResponderRecipeResponderRuleSummary resources items: $ref: '#/components/schemas/ResponderRecipeResponderRuleSummary' type: array required: - items type: object UpdateManagedListDetails: description: Parameters to use to update details for a managed list. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Managed list description. Avoid entering confidential information.' maxLength: 1024 minLength: 1 type: string displayName: description: 'Managed list display name. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object group: description: Managed list type group type: string listItems: description: List of managed list items items: type: string maxLength: 200 minLength: 1 type: array TargetSummary: description: Summary information for a target. properties: compartmentId: description: Compartment OCID where the resource is created type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Target display name type: string doesEmitProblemsToEvents: description: When a problems is triggered on a resource that the target monitors, should an event be emitted to the OCI Events service? type: boolean freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier for target that can't be changed after creation maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] type: string recipeCount: description: Total number of recipes attached to target type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetResourceId: description: Resource ID which the target uses to monitor type: string targetResourceType: description: Type of resource that's associated with the target(compartment/HCMCloud/ERPCloud) enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/TargetResourceType' targetSummaryAdditionalDetails: $ref: '#/components/schemas/TargetSummaryAdditionalDetails' timeCreated: description: The date and time the target was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - targetResourceId - targetResourceType - recipeCount type: object ResponderRecipeSummary: description: Summary information for a responder recipe. properties: compartmentId: description: Compartment OCID type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Responder recipe description type: string displayName: description: Responder recipe display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier for the responder recipe maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the example enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: Responder recipe description enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' responderRules: description: List of responder rules associated with the responder recipe items: $ref: '#/components/schemas/ResponderRecipeResponderRule' type: array sourceResponderRecipeId: description: Unique identifier of the source responder recipe type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the responder recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId type: object DetectorRecipeDetectorRule: description: A DetectorRecipeDetectorRule resource defines a single recipe rule in the collection for a DetectorRecipe resource. properties: candidateResponderRules: description: List of responder rules that can be used to remediate this detector rule items: $ref: '#/components/schemas/CandidateResponderRule' type: array dataSourceId: description: The unique identifier of the attached data source type: string description: description: Description for DetectorRecipeDetectorRule resource type: string details: $ref: '#/components/schemas/DetectorDetails' detector: description: Detector recipe for the rule enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRuleId: description: The unique identifier of the detector rule. maxLength: 255 minLength: 1 type: string displayName: description: Display name for DetectorRecipeDetectorRule resource type: string entitiesMappings: description: Data source entities mapping for the detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array isCloneable: description: Is the rule cloneable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the detector rule. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for DetectorRecipeDetectorRule resource type: string resourceType: description: Resource type of the configuration to which the rule is applied type: string ruleType: description: Detector rule type items: $ref: '#/components/schemas/RuleType' type: array serviceType: description: Service type of the configuration to which the rule is applied type: string sourceDetectorRuleId: description: The ID of the source detector rule type: string timeCreated: description: The date and time the detector recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector recipe rule was last updated. Format defined by RFC3339. format: date-time type: string required: - detectorRuleId - serviceType - resourceType - detector type: object ResponderExecutionSummary: description: A summary of detailed information on responder execution. properties: compartmentId: description: Compartment OCID of the problem for the responder execution type: string id: description: The unique identifier of the responder execution maxLength: 255 minLength: 1 type: string message: description: Message about the responder execution. type: string problemId: description: Problem ID associated with the responder execution type: string problemName: description: Problem name associated with the responder execution type: string region: description: Region where the problem is found type: string resourceName: description: Resource name of the problem for the responder execution. type: string resourceType: description: resource type of the problem for the responder execution type: string responderExecutionMode: description: Possible type of responder execution modes enum: - MANUAL - AUTOMATED - ALL type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionModes' responderExecutionStatus: description: Current execution status of the responder enum: - STARTED - AWAITING_CONFIRMATION - AWAITING_INPUT - SUCCEEDED - FAILED - SKIPPED - ALL type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionStates' responderRuleExecutionDetails: $ref: '#/components/schemas/ResponderRuleExecutionDetails' responderRuleId: description: Responder rule ID for the responder execution type: string responderRuleName: description: Rule name for the responder execution type: string responderRuleType: description: Rule type for the responder execution enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' targetId: description: Target ID of the problem for the responder execution type: string timeCompleted: description: The date and time the responder execution was updated. Format defined by RFC3339. format: date-time type: string timeCreated: description: The date and time the responder execution was created. Format defined by RFC3339. format: date-time type: string required: - id - responderRuleId - responderRuleType - responderRuleName - problemId - problemName - region - targetId - compartmentId - resourceType - resourceName - responderExecutionMode - responderExecutionStatus - timeCreated type: object TacticSummary: description: Summary information for a tactic. properties: displayName: description: Display name of the tactic type: string id: description: Unique identifier for the tactic maxLength: 255 minLength: 1 type: string required: - id - displayName type: object SightingAdditionalEntityCollection: description: The collection of sighting additional entities' details. properties: items: description: List of sighting additional entities' details items: $ref: '#/components/schemas/SightingAdditionalEntitySummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object SecurityZoneCollection: description: A collection of security zones. Results of a security zone search. properties: items: description: List of SecurityZoneSummary resources items: $ref: '#/components/schemas/SecurityZoneSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object TargetResponderRecipeResponderRule: description: 'A TargetResponderRecipeResponderRule resource contains a specific instance of a single responder rule. A TargetResponderRecipeRule resource: * Is effectively a copy of a ResponderRecipeRule resource in which users can make certain changes if it’s Oracle-managed, and other changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is effectively located in a specific OCI compartment, through the ThreatResponderRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply locally, to resources in OCI compartments mapped to the target that attaches the associated responder recipe (in a TargetResponderRecipe resource), and override any changes made in rules associated with the corresponding ResponderRecipe resource. ' properties: compartmentId: description: Compartment OCID type: string description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Responder rule display name type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' policies: description: List of policies items: type: string type: array responderRuleId: description: Unique identifier for the responder rule maxLength: 255 minLength: 1 type: string supportedModes: description: Supported execution modes for the responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the target responder recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target responder recipe rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - responderRuleId - compartmentId type: object ProblemAggregation: description: Provides aggregated information on counts of problems by specified parameters. properties: count: description: The number of occurrences with given dimensions type: integer dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object required: - dimensionsMap - count type: object TargetResponderRecipeResponderRuleCollection: description: Collection of summary information for target responder recipe responder rules. properties: items: description: List of TargetResponderRecipeResponderRuleSummary resources items: $ref: '#/components/schemas/TargetResponderRecipeResponderRuleSummary' type: array required: - items type: object GeographicalLocation: description: The geographical location of a problem in terms of latitude and longitude. properties: latitude: description: Latitude of problem format: double type: number longitude: description: Longitude of problem format: double type: number required: - latitude - longitude type: object CandidateResponderRule: description: Information for a responder rule that can be used to remediate a problem triggered by specific detector rule. properties: displayName: description: The display name of the responder rule maxLength: 255 minLength: 1 type: string id: description: The unique identifier of the responder rule type: string isPreferred: description: Is this the preferred state? type: boolean type: object TargetMonitoringSignalCollection: description: Collection of target monitoring signals. properties: items: description: List of TargetMonitoringSignalSummary resources items: $ref: '#/components/schemas/TargetMonitoringSignalSummary' type: array required: - items type: object ResourceProfileEndpointSummary: description: Summary information for resource profile endpoints. properties: asnNumber: description: ASN number of sighting type: string country: description: Country of sighting type: string id: description: Unique identifier for sighting endpoints type: string ipAddress: description: IP address for sighting type: string ipAddressType: description: Type of IP address for sighting type: string ipClassificationType: description: IP address classification type type: string latitude: description: Latitude of sighting format: double type: number longitude: description: Longitude of sighting format: double type: number problemId: description: Problem ID for sighting endpoints type: string regions: description: Regions where activities were performed from this IP address items: type: string type: array uniqueItems: true resourceProfileId: description: Resource profile ID associated with the impacted resource type: string services: description: List of services where activities were performed from this IP address items: type: string type: array sightingType: description: Type of sighting for sighting endpoints type: string sightingTypeDisplayName: description: Display name of the sighting type type: string timeFirstDetected: description: Time the activities were first detected. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. format: date-time type: string timeLastDetected: description: Time the activities were last detected. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. format: date-time type: string required: - id - resourceProfileId - sightingType - sightingTypeDisplayName - timeLastDetected - ipAddress - ipAddressType type: object LoggingQueryDetails: description: Details for a logging query for a data source. discriminator: propertyName: loggingQueryType properties: loggingQueryType: description: Logging query type for data source enum: - INSIGHT - SIGHTING type: string x-obmcs-top-level-enum: '#/definitions/LoggingQueryType' required: - loggingQueryType CredentialsValidationDetailsItem: description: Credentials validation response. properties: responseCode: description: Credential validation response code maxLength: 255 minLength: 1 type: integer responseStatus: description: Credential validation response status maxLength: 255 minLength: 1 type: string serviceType: description: Type of service enum: - FA - OAM type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' url: description: URL of service maxLength: 255 minLength: 1 type: string required: - serviceType type: object PropertyTuple: description: key and value pair for configuration values properties: key: description: key type: string value: description: value type: string required: - key - value type: object TargetDetectorRecipe: description: 'A TargetDetectorRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target. A TargetDetectorRecipe resource: * Is effectively a copy of a DetectorRecipe resource in which users can make very limited changes if it’s Oracle-managed, and more changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding DetectorRecipe, of which the TargetDetectorRecipe resource is effectively a copy, created when the detector recipe is attached to the target. ' properties: compartmentId: description: Compartment OCID of the detector recipe type: string description: description: Detector recipe description. type: string detector: description: Type of detector enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRecipeId: description: Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based type: string detectorRecipeType: description: Recipe type ( STANDARD, ENTERPRISE ) enum: - LIMITED - BASIC - STANDARD - ENTERPRISE type: string x-obmcs-top-level-enum: '#/definitions/DetectorRecipeEnum' detectorRules: description: List of detector rules for the detector recipe - user input items: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRule' type: array displayName: description: Display name of the detector recipe type: string effectiveDetectorRules: description: List of currently enabled detector rules for the detector type for recipe after applying defaults items: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRule' type: array id: description: OCID for the detector recipe maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array owner: description: Owner of the detector recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' sourceDataRetention: description: The number of days for which source data is retained type: integer timeCreated: description: The date and time the target detector recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target detector recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - owner - detector - detectorRecipeId type: object CreateResponderRecipeDetails: description: Parameters for creating a responder recipe. properties: compartmentId: description: Compartment OCID type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Responder recipe description. Avoid entering confidential information. ' type: string displayName: description: 'Responder recipe display name. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object responderRules: description: List of responder rules to override from source responder recipe items: $ref: '#/components/schemas/UpdateResponderRecipeResponderRule' type: array sourceResponderRecipeId: description: The unique identifier of the source responder recipe type: string required: - displayName - sourceResponderRecipeId - compartmentId type: object ProblemEndpointCollection: description: Collection of problem endpoint summaries. properties: items: description: List of ProblemEndpointSummary resources items: $ref: '#/components/schemas/ProblemEndpointSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ChangeSecurityZoneCompartmentDetails: description: Parameters to be used to move a security zone to a different compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateDetectorRecipeDetectorRule: description: Parameters to use to update a detector rule. properties: details: $ref: '#/components/schemas/UpdateDetectorRuleDetails' detectorRuleId: description: Detector recipe rule ID type: string required: - detectorRuleId - details type: object ResourceTypeSummary: description: A summary of detailed information on a resource type. properties: displayName: description: Display name of the resource type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array name: description: Name of the resource maxLength: 255 minLength: 1 type: string rules: description: List of rules items: $ref: '#/components/schemas/RuleSummary' type: array required: - name - displayName type: object DataMaskRuleCollection: description: Collection of data mask rules. properties: items: description: List of DataMaskRuleSummary resources items: $ref: '#/components/schemas/DataMaskRuleSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object DataSourceEventSummary: description: Summary information about a data source event. properties: comments: description: Data source event comments type: string dataSourceId: description: Unique identifier of data source. type: string eventDate: description: Data source event date and time format: date-time type: string eventInfo: $ref: '#/components/schemas/DataSourceEventInfo' region: description: Data source event region type: string status: description: Current data source event info status enum: - SUCCESS - FAILURE type: string x-obmcs-top-level-enum: '#/definitions/DataSourceEventInfoStatus' timeCreated: description: Data source event creation date and time format: date-time type: string required: - region - eventDate - dataSourceId - eventInfo - timeCreated type: object MitreTacticSummary: description: Summary information for a MITRE ATT@CK framework tactic. properties: displayName: description: Display name of the tactic type: string id: description: Unique identifier for the tactic maxLength: 255 minLength: 1 type: string required: - id - displayName type: object ChangeManagedListCompartmentDetails: description: Parameters to use to move a managed list to a different compartment. properties: compartmentId: description: The OCID of the compartment into which the managed list is to be moved maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ManagedListTypeCollection: description: Collection of managed list type summaries. properties: items: description: List of ManagedListTypeSummary resources items: $ref: '#/components/schemas/ManagedListTypeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object SecurityPolicyCollection: description: Results of a security policy search. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object items: description: A list of SecurityPolicySummary resources items: $ref: '#/components/schemas/SecurityPolicySummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - items type: object ResourceProfileRiskScoreAggregationSummary: description: Summary of resource profile risk score aggregations. properties: items: description: List of ResourceRiskScoreAggregation resources items: $ref: '#/components/schemas/ResourceRiskScoreAggregation' type: array resourceProfileDisplayName: description: Display name for the resource profile type: string resourceProfileId: description: OCID for the resource profile type: string riskThreshold: description: Risk score value that triggers a problem type: integer required: - items - resourceProfileId - resourceProfileDisplayName type: object ResponderRecipeResponderRuleSummary: description: Summary information for a responder rule properties: compartmentId: description: Compartment OCID type: string description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Responder rule display name type: string id: description: Unique identifier for the responder rule maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' policies: description: List of policies items: type: string type: array supportedModes: description: Supported execution modes for the responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the responder recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder recipe rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - id - compartmentId type: object DetectorConfiguration: description: Configuration details for a detector. properties: additionalProperties: description: Map of additional property values for configuration items: $ref: '#/components/schemas/AdditionalConfigPropertyDefinition' type: array allowedValues: description: Map of possible values for configuration items: $ref: '#/components/schemas/PropertyTuple' type: array allowedValuesDataType: description: Map property Value data type type: string configKey: description: Unique identifier of the configuration maxLength: 255 minLength: 1 type: string dataType: description: Configuration data type type: string name: description: Configuration name maxLength: 255 minLength: 1 type: string value: description: Configuration value maxLength: 255 minLength: 1 type: string values: description: List of configuration values items: $ref: '#/components/schemas/ConfigValue' type: array required: - configKey - name type: object ConfigValue: description: Details for a configuration value for a managed list. properties: listType: description: Configuration list item type (CUSTOM or MANAGED) enum: - MANAGED - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/ConfigurationListItemType' managedListType: description: Type of content in the managed list type: string value: description: Configuration value type: string required: - listType - managedListType - value type: object DataSource: description: Detailed information for a data source (DataSource resource). properties: compartmentId: description: Compartment OCID of data source type: string dataSourceDetails: $ref: '#/components/schemas/DataSourceDetails' dataSourceDetectorMappingInfo: description: Information about the detector recipe and rule attached items: $ref: '#/components/schemas/DataSourceMappingInfo' type: array dataSourceFeedProvider: description: Possible type of dataSourceFeed Provider(LoggingQuery) enum: - LOGGINGQUERY type: string x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detailed description of the data source. type: string displayName: description: Display name of the data source type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: OCID for the data source maxLength: 255 minLength: 1 type: string isDataSourceCompartmentConfigured: description: Check target and data source compartment configuration (data source in target sub-compartment) type: boolean lifecycleState: description: The current lifecycle state of the resource. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array regionStatusDetail: description: Information about the region and status of query replication items: $ref: '#/components/schemas/RegionStatusDetail' type: array status: description: Enablement status of the data source enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataSourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the Data source was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the data source was updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - dataSourceFeedProvider type: object DetectorCollection: description: The collection of detector summaries. properties: items: description: List of DetectorSummary resources items: $ref: '#/components/schemas/DetectorSummary' type: array required: - items type: object Configuration: description: Specifies several key settings for a Cloud Guard tenancy, identified by tenancy root compartment OCID. properties: reportingRegion: description: The reporting region type: string selfManageResources: description: 'Were Oracle-managed resources created by customer? ' type: boolean status: description: Status of the Cloud Guard tenant enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/CloudGuardStatus' required: - reportingRegion ResourceRiskScoreAggregation: description: Risk score of a resource. properties: riskLevel: description: The risk level enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' riskScore: description: The risk score format: double type: number scoreTimestamp: description: The date and time for which the score is calculated. Format defined by RFC3339. format: int64 type: number tactics: description: List of tactics used for evaluating the risk score items: type: string type: array uniqueItems: true required: - scoreTimestamp - riskScore - riskLevel - tactics type: object ResourceProfileRiskScoreAggregationSummaryCollection: description: Collection of resource profile risk score aggregation summaries. properties: items: description: List of ResourceProfileRiskScoreAggregationSummary resources items: $ref: '#/components/schemas/ResourceProfileRiskScoreAggregationSummary' type: array required: - items type: object MonitoringResourceSummary: description: Summary of monitoring resource information. properties: displayName: description: Monitoring resource display name type: string id: description: Monitoring resource ID type: string items: description: List of monitoring resources items: $ref: '#/components/schemas/MonitoringResourceSummary' type: array type: object ProblemCollection: description: Collection of summary information for problems. properties: items: description: List of ProblemSummary resources items: $ref: '#/components/schemas/ProblemSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateBulkProblemStatusDetails: description: List of problem IDs to be passed in to update problem status. properties: comment: description: User-defined comment to be passed in to update the problem type: string problemIds: description: List of problem IDs to be passed in to update the problem status items: type: string maxItems: 20 minItems: 1 type: array uniqueItems: true status: description: Action taken by user enum: - OPEN - RESOLVED - DISMISSED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' required: - problemIds - status type: object TechniqueSummary: description: Summary information for a technique. properties: displayName: description: Display name of the technique type: string id: description: Unique identifier for the technique maxLength: 255 minLength: 1 type: string required: - id - displayName type: object CreateTargetDetectorRecipeDetails: description: Parameters to use to create a target detector recipe. properties: detectorRecipeId: description: Unique identifier for the target detector recipe maxLength: 255 minLength: 1 type: string detectorRules: description: List of overrides to be applied to detector rules associated with the target items: $ref: '#/components/schemas/UpdateTargetRecipeDetectorRuleDetails' type: array required: - detectorRecipeId type: object WorkRequestSummary: description: Summary information about a work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' type: string id: description: Unique identifier of the work request type: string operationType: description: Type of the work request enum: - CREATE - UPDATE - DELETE - MOVE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of work request completed format: float type: number resources: description: List of resources affected by this work request items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: The date and time the request was created format: date-time type: string timeFinished: description: The date and time the request was finished format: date-time type: string timeStarted: description: The date and time the request was started format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted ResourceProfileSummary: description: Summary information for a resource profile. properties: displayName: description: Display name for the resource profile type: string id: description: Unique identifier for the resource profile type: string problemsCount: description: Number of problems associated with this resource profile type: integer resourceId: description: Unique identifier for the resource associated with the resource profile type: string riskScore: description: Risk score for the resource profile format: double type: number sightingsCount: description: Number of sightings associated with the resource profile type: integer tactics: description: List of tactic summaries associated with the resource profile items: $ref: '#/components/schemas/TacticSummary' type: array uniqueItems: true timeFirstDetected: description: Time the activities were first detected. Format defined by RFC3339. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: Time the activities were last detected. Format defined by RFC3339. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. Format defined by RFC3339. format: date-time type: string type: description: Resource type for the resource profile type: string required: - id - resourceId - displayName - type - riskScore - tactics - timeFirstDetected - timeLastDetected type: object TargetDetectorRecipeDetectorRuleCollection: description: Collection of summary information for target detector recipe detector rules. properties: items: description: List of TargetDetectorRecipeDetectorRuleSummary resources items: $ref: '#/components/schemas/TargetDetectorRecipeDetectorRuleSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateDetectorRecipeDetectorRuleDetails: description: Parameters to use to update details in a detector rule. properties: details: $ref: '#/components/schemas/UpdateDetectorRuleDetails' type: object ManagedList: description: A managed list is a reusable list of parameters that makes it easier to set the scope for detector and responder rules. A ManagedList resource contains the reusable list of parameters, plus metadata for the list. properties: compartmentId: description: Compartment OCID where the resource is created type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Managed list description type: string displayName: description: Managed list display name type: string feedProvider: description: Provider of the managed list feed enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/FeedProviderType' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object group: description: Managed list type group type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string isEditable: description: Is this list editable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] type: string listItems: description: List of items in the managed list items: type: string type: array listType: description: Type of information contained in the managed list enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string x-obmcs-top-level-enum: '#/definitions/ManagedListType' sourceManagedListId: description: OCID of the source managed list type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the managed list was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the managed list was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - displayName - listType type: object TargetDetectorRecipeDetectorRule: description: 'A TargetDetectorRecipeDetectorRule resource contains a specific instance of a single detector rule in one of the supported detector types (for example, activity, configuration, or threat). A TargetDetectorRecipeDetectorRule resource: * Is effectively a copy of a DetectorRecipeRule resource (made when a detector recipe is attached to a target) in which users can make certain changes if it’s Oracle-managed, and other changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is effectively located in a specific OCI compartment, through the ThreatDetectorRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply locally, to resources in OCI compartments mapped to the target that attaches the associated detector recipe (in a TargetDetectorRecipe resource), and override any changes made in rules associated with the corresponding DetectorRecipe resource. ' properties: dataSourceId: description: The ID of the attached data source type: string description: description: Description for TargetDetectorRecipeDetectorRule resource type: string details: $ref: '#/components/schemas/TargetDetectorDetails' detector: description: Detector type for the rule enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRuleId: description: The unique identifier of the detector rule maxLength: 255 minLength: 1 type: string displayName: description: Display name for TargetDetectorRecipeDetectorRule resource type: string entitiesMappings: description: Data source entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array isCloneable: description: Is the rule cloneable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the detector rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for TargetDetectorRecipeDetectorRule resource type: string resourceType: description: 'The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference). Or try [Detector Recipe Reference] (/cloud-guard/using/detect-recipes.htm#detect-recipes-reference). ' type: string ruleType: description: Rule category type items: $ref: '#/components/schemas/RuleType' type: array serviceType: description: Service type of the configuration to which the rule is applied type: string sourceDetectorRuleId: description: The unique identifier of the source detector rule type: string timeCreated: description: The date and time the target detector recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target detector recipe rule was last updated. Format defined by RFC3339. format: date-time type: string required: - detectorRuleId - serviceType - resourceType - detector type: object DataMaskRuleSummary: description: Summary information for a data mask rule. properties: compartmentId: description: Compartment OCID where the resource is created type: string dataMaskCategories: description: List of data mask rule categories items: enum: - ACTOR - PII - PHI - FINANCIAL - LOCATION - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DataMaskCategory' type: array dataMaskRuleStatus: description: The current status of the data mask rule enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataMaskRuleStatus' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The data mask rule description type: string displayName: description: Data mask rule display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object iamGroupId: description: IAM group ID associated with the data mask rule type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the data mask rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetSelected: $ref: '#/components/schemas/TargetSelected' timeCreated: description: The date and time the target was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target was updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - iamGroupId - targetSelected type: object UpdateResponderRuleDetails: description: Parameters to be updated for a responder rule within a responder recipe. properties: isEnabled: description: Enablement state for the responder rule type: boolean required: - isEnabled type: object UpdateConfigurationDetails: description: Parameters to update Cloud Guard configuration details for a tenancy. properties: reportingRegion: description: The reporting region type: string selfManageResources: description: 'Identifies if Oracle managed resources will be created by customers. If no value is specified false is the default. ' type: boolean status: description: Status of Cloud Guard tenant enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/CloudGuardStatus' required: - reportingRegion - status DetectorRecipeDetectorRuleCollection: description: Collection of summary information for detector rules in a detector recipe. properties: items: description: List of DetectorRecipeDetectorRuleSummary resources items: $ref: '#/components/schemas/DetectorRecipeDetectorRuleSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object RequestSummarizedTrendResourceRiskScoresDetails: description: Details for requesting summarized trend risk scores. properties: filter: description: The filter type enum: - PROBLEM_ID - RESOURCE_PROFILE_ID type: string x-obmcs-top-level-enum: '#/definitions/ResourceRiskScoreDimension' filterId: description: ID to be passed in to filter the risk scores type: string required: - filter - filterId type: object DetectorRecipeDetectorRuleSightingTypeSummary: description: Summary of detector sighting type. properties: additionalEntitiesMapping: description: Data source additional entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' maxItems: 15 minItems: 0 type: array dataSourceId: description: Unique identifier of the associated data source type: string displayName: description: Sighting type display name type: string id: description: Unique identifier of a sighting type type: string mitreDetails: $ref: '#/components/schemas/MitreDetails' owner: description: The detector type for the rule enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' tactic: description: MITRE ATT@CK framework tactic associated with a sighting type type: string techniques: description: MITRE ATT@CK framework techniques associated with a sighting type items: type: string maxItems: 255 minItems: 1 type: array timeCreated: description: The date and time the sighting type was first created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the sighting type was last updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - tactic - techniques type: object DataSourceEventCollection: description: The collection of events related to a data source. properties: items: description: List of events related to a data source items: $ref: '#/components/schemas/DataSourceEventSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ResponderActivitySummary: description: Responder activity summary definition. properties: id: description: Unique ID for responder activity maxLength: 255 minLength: 1 type: string message: description: Additional message related to this operation type: string problemId: description: Unique ID of problem associated with responder activity type: string responderActivityType: description: Responder activity type enum: - STARTED - COMPLETED type: string x-obmcs-top-level-enum: '#/definitions/ResponderActivityType' responderExecutionStatus: description: Responder execution status enum: - STARTED - AWAITING_CONFIRMATION - AWAITING_INPUT - SUCCEEDED - FAILED - SKIPPED - ALL type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionStates' responderRuleId: description: Unique ID of the responder rule associated with the problem type: string responderRuleName: description: Responder rule name type: string responderType: description: Responder rule type for performing the operation enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' timeCreated: description: Responder activity starting time format: date-time type: string required: - id - problemId - responderRuleId - responderType - responderRuleName - responderActivityType - responderExecutionStatus - timeCreated - message type: object ResponderExecutionTrendAggregation: description: Provides the timestamps and their corresponding number of remediations. properties: count: description: The number of remediations for a given time type: integer dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object durationInSeconds: description: Duration type: integer startTimestamp: description: Start time in epoch seconds format: int64 type: number required: - dimensionsMap - startTimestamp - durationInSeconds - count type: object RecommendationSummaryCollection: description: Collection of RecommendationSummary resources. properties: items: description: List of RecommendationSummary resources items: $ref: '#/components/schemas/RecommendationSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ResourceProfileImpactedResourceSummary: description: Summary information on impacted resource in resource profile. properties: compartmentId: description: Compartment ID for impacted resource type: string id: description: Unique identifier for impacted resource type: string problemId: description: Problem ID associated with the impacted resource type: string region: description: Region for impacted resource type: string resourceId: description: Impacted resource ID type: string resourceName: description: Impacted resource name type: string resourceProfileId: description: Resource profile ID associated with the impacted resource type: string resourceType: description: Impacted resource type type: string sightingType: description: Sighting type for impacted resource type: string sightingTypeDisplayName: description: Display name of the sighting type type: string timeFirstDetected: description: Time the activities were first detected. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. format: date-time type: string timeIdentified: description: Time when the impacted resource is identified for the resource profile. format: date-time type: string timeLastDetected: description: Time the activities were last detected. Same as timeIdentified. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. format: date-time type: string required: - id - resourceProfileId - compartmentId - resourceId - resourceName - resourceType - sightingType - sightingTypeDisplayName - region - timeIdentified type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: A human-readable log message type: string timestamp: description: The time the log message was written format: date-time type: string required: - message - timestamp WorkRequest: description: Detailed information about a work request (WorkRequest resource). properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' type: string id: description: Unique identifier of the work request type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array operationType: description: Operation type of the work request enum: - CREATE - UPDATE - DELETE - MOVE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the work request that's completed format: float type: number resources: description: List of resources affected by the work request items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Operation status of the work request enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: The date and time the work request was created format: date-time type: string timeFinished: description: The date and time the work request was finished format: date-time type: string timeStarted: description: The date and time the work request was started format: date-time type: string required: - id - operationType - status - compartmentId - resources - percentComplete - timeAccepted SightingAdditionalEntitySummary: description: Additional information about sighting additional entities' details. properties: additionalEntityDetails: description: The additional details of the sighting additional entity items: $ref: '#/components/schemas/EntityDetails' type: array id: description: Sighting additional entity ID type: string regions: description: Addition entities regions items: type: string type: array resultUrl: description: Log result query URL type: string sightingId: description: Associated sighting ID type: string timeFirstDetected: description: First detected time format: date-time type: string timeLastDetected: description: The date and time the sighting was last detected format: date-time type: string required: - regions - id - sightingId - timeFirstDetected - timeLastDetected type: object DetectorRecipeDetectorRuleSightingType: description: The sighting type associated with a Threat Detector rule. properties: additionalEntitiesMapping: description: Data source additional entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' maxItems: 15 minItems: 0 type: array dataSourceId: description: Unique identifier of the associated data source type: string description: description: Description of the sighting type type: string displayName: description: Display name of the sighting type type: string id: description: The unique identifier of the sighting type type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array mitreDetails: $ref: '#/components/schemas/MitreDetails' mitreLink: description: MITRE ATT@CK framework link for the sighting type type: string owner: description: Owner type for the sighting type enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' tactic: description: MITRE ATT@CK framework tactic associated with a sighting type type: string techniques: description: MITRE ATT@CK framework techniques associated with a sighting type items: type: string maxItems: 255 minItems: 1 type: array timeCreated: description: The date and time the sighting type was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the sighting type was updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - tactic - techniques type: object RegionStatusDetail: description: Status of replication of a data source query in a region properties: region: description: Data source replication region type: string status: description: Data source replication region status enum: - PROVISIONING - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/QueryReplicationStatus' required: - region - status type: object ResourceProfileEndpointCollection: description: Collection of resource profile endpoint summaries. properties: items: description: List of ResourceProfileEndpointSummary resources items: $ref: '#/components/schemas/ResourceProfileEndpointSummary' type: array required: - items type: object ImpactedResourceCollection: description: Collection of impacted resource summaries. properties: items: description: List of ImpactedResourceSummary resources items: $ref: '#/components/schemas/ImpactedResourceSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateTargetResponderRuleDetails: description: 'Parameters to update details for a responder rule for a target responder recipe. TargetResponderRuleDetails contains all configurations associated with the ResponderRule, whereas UpdateTargetResponderRecipeResponderRuleDetails refers to the details that are to be updated for ResponderRule. ' properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of responder rule configurations items: $ref: '#/components/schemas/ResponderConfiguration' type: array mode: description: Execution mode for the responder rule enum: - AUTOACTION - USERACTION type: string x-obmcs-top-level-enum: '#/definitions/ResponderModeTypes' type: object SecurityZoneSummary: description: 'Summary information for a security zone. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. ' properties: compartmentId: description: The OCID of the compartment for the security zone type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security zone's description type: string displayName: description: The security zone's display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique security zone identifier that can't be changed after creation type: string isInheritanceAfterDeleteEnabled: default: true description: Indicates if upon deletion of the security zone the comparment should inherit parent security zone type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the security zone enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' securityZoneRecipeId: description: The OCID of the recipe (`SecurityRecipe` resource) for the security zone type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the security zone was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the security zone was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - securityZoneRecipeId type: object ResponderRule: description: 'A ResponderRule resource contains the default settings for a single responder rule that Cloud Guard provides. A ResponderRule resource: * Is used as the original source for a rule in an Oracle-managed responder of the specified type. * Is not directly visible in the Cloud Guard UI. * Can’t be modified by users, programmatically or through the UI. * May be modified from time to time by Cloud Guard. ' properties: description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Responder rule display name type: string id: description: Unique identifier for the responder rule maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array policies: description: List of policies items: type: string type: array supportedModes: description: Supported execution modes for the responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the responder rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - id - displayName - description - type type: object SightingImpactedResourceSummary: description: Summary of resources impacted by a sighting. properties: compartmentId: description: Compartment ID for impacted resource type: string id: description: Unique identifier for an impacted resource type: string problemId: description: Problem ID for impacted resource type: string region: description: Region for impacted resource type: string resourceId: description: Impacted resource ID type: string resourceName: description: Resource name type: string resourceType: description: Resource type type: string sightingId: description: Sighting ID for impacted resource type: string timeFirstDetected: description: Time the activities were first detected. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. format: date-time type: string timeIdentified: description: Date and time when the impacted resource is identified for given sighting format: date-time type: string timeLastDetected: description: Time the activities were last detected. Same as timeIdentified. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. format: date-time type: string required: - id - resourceId - sightingId - compartmentId - resourceName - resourceType - region - timeIdentified type: object ConditionMetadataTypeSummary: description: Additional information on supported condition types. properties: description: description: Display name of the condition type type: string id: description: Unique identifier of the condition type maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - id - description type: object AttachTargetDetectorRecipeDetails: description: 'Identifier for an existing detector recipe to use to create a new detector recipe (TargetDetectorRecipe resource) to be attached to a target. ' properties: detectorRecipeId: description: Detector recipe unique identifier maxLength: 255 minLength: 1 type: string required: - detectorRecipeId type: object DetectorRule: description: Information for a detector rule (DetectorRule object). properties: candidateResponderRules: description: List of responder rules that could be used to remediate a problem triggered by this detector rule items: $ref: '#/components/schemas/CandidateResponderRule' type: array description: description: Description for the detector rule type: string detector: description: Detector recipe for the rule enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorDetails: $ref: '#/components/schemas/DetectorDetails' displayName: description: Display name for the detector rule type: string id: description: The unique identifier of the detector rule maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the detector rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for the detector rule type: string resourceType: description: Resource type of the configuration to which the rule is applied type: string serviceType: description: Service type of the configuration to which the rule is applied type: string timeCreated: description: The date and time the detector rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector rule was updated. Format defined by RFC3339. format: date-time type: string required: - id - serviceType - resourceType - detector type: object WorkRequestResource: description: Parameters of a work request resource, which is created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource that the work request affects type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier ChangeDataSourceCompartmentDetails: description: The compartmentId for the compartment into which the data source is to be moved. properties: compartmentId: description: The OCID of the compartment into which the data source is to be moved maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ProblemTrendAggregation: description: Provides aggregated information on trends for counts of problems by specified parameters. properties: count: description: The number of occurrences for the corresponding time range and dimensions. type: integer dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object durationInSeconds: description: Duration type: integer startTimestamp: description: Start time in epoch seconds format: int64 type: number required: - dimensionsMap - startTimestamp - durationInSeconds - count type: object ResponderRuleCollection: description: Collection of responder rule summaries. properties: items: description: List of ResponderRuleSummary resources items: $ref: '#/components/schemas/ResponderRuleSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object WorkRequestError: description: 'Summary information for an error (WorkRequestError resource) encountered while executing a work request ' properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). ' type: string message: description: A human readable description of the issue encountered type: string timestamp: description: The time the error occured format: date-time type: string required: - code - message - timestamp ResourceProfileImpactedResourceCollection: description: Collection of resource profile impacted resource summaries properties: items: description: List of ResourceProfileImpactedResourceSummary resources items: $ref: '#/components/schemas/ResourceProfileImpactedResourceSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ConditionMetadataType: description: The metadata definition of the requested condition type. properties: locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array name: description: Name used to identify the condition metadata type maxLength: 255 minLength: 1 type: string serviceTypes: description: Collection of ServiceTypeSummary resources items: $ref: '#/components/schemas/ServiceTypeSummary' type: array required: - name - serviceTypes type: object RecommendationSummary: description: Recommendation definition. properties: compartmentId: description: Compartment OCID type: string description: description: Description of the recommendation type: string details: additionalProperties: type: string description: Recommendation details type: object id: description: Unique identifier for the recommendation type: string lifecycleDetail: description: Additional details on the substate of the lifecycle state enum: - OPEN - RESOLVED - DISMISSED type: string x-obmcs-top-level-enum: '#/definitions/RecommendationLifecycleDetail' lifecycleState: description: The current lifecycle state of the recommendation enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: Recommendation string that appears in the UI for the problem type: string problemCount: description: Count number of the problem format: int64 type: integer riskLevel: description: The risk level of the problem enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' targetId: description: Target ID associated with the problem type: string tenantId: description: Tenant identifier type: string timeCreated: description: The date and time the problem was first created format: date-time type: string timeUpdated: description: The date and time the problem was last updated format: date-time type: string type: description: Recommendation type enum: - DETECTOR_PROBLEMS - RESOLVED_PROBLEMS type: string x-obmcs-top-level-enum: '#/definitions/RecommendationType' required: - id - compartmentId - targetId - details - problemCount - lifecycleState - lifecycleDetail - name - description type: object ServiceTypeSummary: description: Summary information for a service type. properties: name: description: Name of the service type maxLength: 255 minLength: 1 type: string resourceTypes: description: List of resource types items: $ref: '#/components/schemas/ResourceTypeSummary' type: array required: - name - resourceTypes type: object TargetResponderRecipe: description: 'A TargetResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target. A TargetResponderRecipe resource: * Is effectively a copy of a ResponderRecipe resource in which users can make very limited changes if it’s Oracle-managed, and more changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding ResponderRecipe, of which the TargetResponderRecipe resource is effectively a copy of the ResponderRecipe resource (effectively created when the detector recipe is attached to the target). ' properties: compartmentId: description: Compartment OCID type: string description: description: Target responder description type: string displayName: description: Target responder recipe display name type: string effectiveResponderRules: description: List of currently enabled responder rules for the responder type for recipe after applying defaults items: $ref: '#/components/schemas/TargetResponderRecipeResponderRule' type: array id: description: Unique identifier of target responder recipe that can't be changed after creation maxLength: 255 minLength: 1 type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array owner: description: Owner of target responder recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' responderRecipeId: description: Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned maxLength: 255 minLength: 1 type: string responderRules: description: List of responder rules associated with the recipe - user input items: $ref: '#/components/schemas/TargetResponderRecipeResponderRule' type: array timeCreated: description: The date and time the target responder recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target responder recipe rule was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - responderRecipeId - displayName - description - owner type: object ResourceRiskScoreAggregationCollection: description: Collection of risk score aggregations. properties: filterId: description: ID for filter that to be used to filter risk scores type: string filterType: description: Type of filter type: string items: description: List of ResourceRiskScoreAggregation resources items: $ref: '#/components/schemas/ResourceRiskScoreAggregation' type: array riskThreshold: description: Risk score value that triggers a problem type: integer required: - items - filterType - filterId type: object DataMaskRule: description: A data mask rule specifies the conditions in which the value for a sensitive data field in the UI is to be hidden or displayed when viewed by specified groups of users. The DataMaskRule resource contains the parameters for a data mask rule. properties: compartmentId: description: Compartment OCID where the resource is created type: string dataMaskCategories: description: List of data mask rule categories items: enum: - ACTOR - PII - PHI - FINANCIAL - LOCATION - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DataMaskCategory' type: array dataMaskRuleStatus: description: The current status of the data mask rule enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataMaskRuleStatus' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The data mask rule description type: string displayName: description: Data mask rule display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object iamGroupId: description: IAM Group ID associated with the data mask rule type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional details on the substate of the lifecycle state maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the data mask rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: Additional details on the substate of the lifecycle state [DEPRECATE] type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetSelected: $ref: '#/components/schemas/TargetSelected' timeCreated: description: The date and time the target was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target was updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - iamGroupId - targetSelected type: object ProblemEntityCollection: description: The collection of problem entities detail related to a data source. properties: items: description: List of entity details related to a data source items: $ref: '#/components/schemas/ProblemEntitySummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object RuleSummary: description: Summary information for a rule. properties: description: description: Description of the rule type: string id: description: Unique identifier of the rule type: string parameters: description: List of parameters applicable for the rule items: $ref: '#/components/schemas/OperatorSummary' type: array required: - id - description - parameters type: object Detector: description: Information for a single detector category. For example, IAAS_ACTIVITY_DETECTOR or IAAS_CONFIGURATION_DETECTOR. properties: description: description: Detector description type: string id: description: Unique identifier for detector maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' required: - id - description type: object ResponderExecutionTrendAggregationCollection: description: Collection of ResponderExecutionTrendAggregation resources. properties: items: description: List of all the ResponderExecutionTrendAggregation resources. items: $ref: '#/components/schemas/ResponderExecutionTrendAggregation' type: array required: - items type: object DetectorRuleSummary: description: Summary information for a detector rule. properties: candidateResponderRules: description: List of responder rules that can be used to remediate a problem triggered by this detector rule items: $ref: '#/components/schemas/CandidateResponderRule' type: array description: description: Description for the detector rule type: string detector: description: Possible types of detectors enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorDetails: $ref: '#/components/schemas/DetectorDetails' displayName: description: Display name for the detector rule type: string id: description: The unique identifier of the detector rule maxLength: 255 minLength: 1 type: string isCloneable: description: Is the rule cloneable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the detector rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for the detector rule type: string resourceType: description: Resource type of the configuration to which the rule is applied type: string ruleType: description: Detector rule type items: $ref: '#/components/schemas/RuleType' type: array serviceType: description: Service type of the configuration to which the rule is applied type: string sourceDetectorRuleId: description: The ID of source detector rule type: string timeCreated: description: The date and time the detector rule was first created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector rule was last updated. Format defined by RFC3339. format: date-time type: string required: - id - detector type: object UpdateTargetRecipeDetectorRuleDetails: description: Parameters to be used to update a detector rule in a target detector recipe. properties: details: $ref: '#/components/schemas/UpdateTargetDetectorRuleDetails' detectorRuleId: description: Unique identifier for the detector rule maxLength: 255 minLength: 1 type: string required: - detectorRuleId - details type: object CreateDataMaskRuleDetails: description: Parameters to us to create a new data mask rule. properties: compartmentId: description: Compartment OCID where the resource is created type: string dataMaskCategories: description: Data mask rule categories items: enum: - ACTOR - PII - PHI - FINANCIAL - LOCATION - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DataMaskCategory' type: array dataMaskRuleStatus: description: The current status of the data mask rule enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataMaskRuleStatus' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The data mask rule description Avoid entering confidential information.' type: string displayName: description: 'Data mask rule display name Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object iamGroupId: description: IAM group ID associated with the data mask rule type: string lifecycleState: description: The current lifecycle state of the data mask rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' targetSelected: $ref: '#/components/schemas/TargetSelected' required: - displayName - compartmentId - iamGroupId - targetSelected - dataMaskCategories type: object ManagedListCollection: description: Collection of managed list summaries. properties: items: description: List of ManagedListSummary resources items: $ref: '#/components/schemas/ManagedListSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object TargetResponderRecipeCollection: description: Collection of target responder recipe summaries. properties: items: description: List of TargetResponderRecipeSummary resources items: $ref: '#/components/schemas/TargetResponderRecipeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing type: string message: description: A human-readable error string type: string required: - code - message UpdateSightingDetails: description: The classification status of a sighting. properties: classificationStatus: description: Sighting classification status selected by the user type: string x-obmcs-top-level-enum: '#/definitions/ClassificationStatus' required: - classificationStatus type: object RemoveCompartmentDetails: description: Detailed information on a compartment to be removed from a security zone. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to be removed from SecurityZone. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeResponderRecipeCompartmentDetails: description: Parameters to use to move a responder recipe to a different compartment. properties: compartmentId: description: The OCID of the compartment into which the responder recipe is to be moved maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DataSourceEventInfo: description: 'This resource can have multiple subtypes, depending on the dataSourceFeedProvider value. For example, if dataSourceFeedProvider is LOGGINGQUERY, this resource will be of type LoggingEventInfo. ' discriminator: propertyName: dataSourceFeedProvider properties: dataSourceFeedProvider: description: Possible type of dataSourceFeed Provider (LoggingQuery) enum: - LOGGINGQUERY type: string x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' required: - dataSourceFeedProvider ResponderRuleDetails: description: Detailed information for a responder rule properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of responder rule configurations items: $ref: '#/components/schemas/ResponderConfiguration' type: array isEnabled: description: Enabled state for the responder rule type: boolean mode: description: Execution mode for the responder rule enum: - AUTOACTION - USERACTION type: string x-obmcs-top-level-enum: '#/definitions/ResponderModeTypes' required: - isEnabled type: object WorkRequestSummaryCollection: description: Collection of work request summaries. properties: items: description: List of workRequestSummary resources items: $ref: '#/components/schemas/WorkRequestSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object SecurityRecipe: description: 'A security zone recipe (SecurityRecipe resource) is a collection of security zone policies (SecurityPolicy resources). Oracle Cloud Infrastructure enforces these policies on security zones that use the recipe. ' properties: compartmentId: description: The OCID of the compartment that contains the recipe type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The recipe's description type: string displayName: description: The recipe's display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier that can’t be changed after creation type: string lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the recipe enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: The owner of the recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' securityPolicies: description: The list of security policy IDs that are included in the recipe items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the recipe was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the recipe was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - securityPolicies - owner type: object AdditionalConfigPropertyDefinition: description: Detector rule additional property field properties: key: description: Name for Additional Property, for example, "interpreter", "router" type: string propertyType: description: Property Type enum: - HINT - RANGE type: string value: description: Value for Property Name, for example, "generic", "cloudguard" type: string type: object UpdateDataMaskRuleDetails: description: The information to be updated for a data mask rule. properties: compartmentId: description: Compartment OCID where the resource is created type: string dataMaskCategories: description: Data mask rule categories items: enum: - ACTOR - PII - PHI - FINANCIAL - LOCATION - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DataMaskCategory' type: array dataMaskRuleStatus: description: The status of the data mask rule enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataMaskRuleStatus' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Data mask rule display name Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object iamGroupId: description: IAM group ID associated with the data mask rule type: string targetSelected: $ref: '#/components/schemas/TargetSelected' type: object ExecuteResponderExecutionDetails: description: The configuration details for a responder rule execution. properties: configurations: description: List of responder rule configurations items: $ref: '#/components/schemas/ResponderConfiguration' type: array type: object UpdateTargetDetectorRecipeDetails: description: Parameters to be used to update a target detector recipe. properties: detectorRecipeId: description: Unique identifier for the target detector recipe type: string detectorRules: description: List of updates to be applied to detector rules in target detector recipe items: $ref: '#/components/schemas/UpdateTargetRecipeDetectorRuleDetails' type: array isValidationOnlyQuery: default: false description: Is validation to be performed for attaching the detector recipe? type: boolean type: object SkipBulkResponderExecutionDetails: description: Details of responders to skip execution. properties: responderExecutionIds: description: List of responder execution IDs to skip execution items: type: string maxItems: 20 minItems: 1 type: array uniqueItems: true required: - responderExecutionIds type: object ProblemEndpointSummary: description: Summary information for endpoints associated with a problem (Problem object). properties: asnNumber: description: ASN number of the endpoint type: string country: description: Country of the endpoint type: string id: description: Unique identifier for problem endpoint. type: string ipAddress: description: IP address of the endpoint type: string ipAddressType: description: Type of IP address for the endpoint type: string ipClassificationType: description: IP address classification type for the endpoint type: string latitude: description: Latitude of the endpoint format: double type: number longitude: description: Longitude of the endpoint format: double type: number problemId: description: Unique identifier for problem associated with the endpoint type: string regions: description: Regions where activities were performed from this IP address items: type: string type: array uniqueItems: true services: description: List of services where activities were performed from this IP address items: type: string type: array sightingId: description: Unique identifier for sighting associated with the endpoint type: string sightingType: description: Unique identifier for the sighting type associated with the endpoint type: string sightingTypeDisplayName: description: Display name of the sighting type type: string timeLastDetected: description: Time when activities were last detected format: date-time type: string required: - id - sightingId - sightingType - sightingTypeDisplayName - problemId - timeLastDetected - ipAddress - ipAddressType type: object DetectorRecipeSummary: description: Summary information for a detector recipe. properties: compartmentId: description: Compartment OCID of detector recipe type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detector recipe description type: string detector: description: Type of detector enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRecipeType: description: Recipe type ( STANDARD, ENTERPRISE ) enum: - LIMITED - BASIC - STANDARD - ENTERPRISE type: string x-obmcs-top-level-enum: '#/definitions/DetectorRecipeEnum' detectorRules: description: List of detector rules for the detector type items: $ref: '#/components/schemas/DetectorRecipeDetectorRule' type: array displayName: description: Display name for detector recipe type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: OCID for detector recipe maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: Owner of the detector recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' sourceDataRetention: description: The number of days for which source data is retained type: integer sourceDetectorRecipeId: description: Recipe OCID of the source recipe to be cloned type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the detector recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - owner - detector type: object UpdateTargetDetectorRuleDetails: description: Parameters to update detector rule configuration details in a detector recipe attached to a target. properties: conditionGroups: description: Condition group corresponding to each compartment items: $ref: '#/components/schemas/ConditionGroup' type: array type: object UpdateProblemStatusDetails: description: The additional details to be updated for the problem. properties: comment: description: User comments type: string sightingStatus: description: Sighting feedback status type: string status: description: Action taken by user enum: - OPEN - RESOLVED - DISMISSED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' required: - status type: object PolicySummary: description: A policy summary (PolicySummary object) contains a list of all current global policy statements (policy attributes). properties: policy: description: Global policy statement type: string required: - policy type: object DetectorSummary: description: Summary information for a detector. properties: description: description: Detector description type: string id: description: Unique identifier for the detector maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - id type: object UpdateTargetDetails: description: The target information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Display name of a target. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string doesEmitProblemsToEvents: description: Should problems detected be emitted to OCI Events service? type: boolean freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object lifecycleState: description: The current lifecycle state of the Target. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' targetDetectorRecipes: description: The details of target detector recipes to be updated items: $ref: '#/components/schemas/UpdateTargetDetectorRecipe' type: array targetResponderRecipes: description: The details of target responder recipes to be updated items: $ref: '#/components/schemas/UpdateTargetResponderRecipe' type: array type: object TacticCollection: description: Collection of tactic summaries. properties: items: description: List of TacticSummay resources items: $ref: '#/components/schemas/TacticSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object RiskScoreAggregationCollection: description: Collection of RiskScoreAggregation resources. properties: items: description: The list of all the RiskScoreAggregation resources. items: $ref: '#/components/schemas/RiskScoreAggregation' type: array required: - items type: object SecurityScoreTrendAggregation: description: Provides the dimensions and their corresponding time and security score. properties: dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object durationInSeconds: description: Duration type: integer securityRating: description: The security rating with given dimensions and time range enum: - EXCELLENT - GOOD - FAIR - POOR - NA type: string x-obmcs-top-level-enum: '#/definitions/SecurityRating' securityScore: description: The security score with given dimensions and time range type: integer startTimestamp: description: Start time in epoch seconds format: int64 type: number required: - dimensionsMap - startTimestamp - durationInSeconds - securityRating - securityScore type: object ResourceTypeCollection: description: Collection of supported resource types. properties: items: description: List of ResourceTypeSummary resources items: $ref: '#/components/schemas/ResourceTypeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object RiskScoreAggregation: description: Provides the dimensions and their corresponding risk score. properties: dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names type: object riskScore: description: The risk score with given dimensions type: integer required: - dimensionsMap - riskScore type: object ChangeSecurityRecipeCompartmentDetails: description: Parameters to be used to move a security recipe to a different compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SightingEndpointCollection: description: Collection of sighting endpoint summaries. properties: items: description: List of SightingEndpointSummary resources items: $ref: '#/components/schemas/SightingEndpointSummary' type: array required: - items type: object MitreTechnique: description: MITRE ATT@CK framework technique properties: displayName: description: Display name of the MITRE ATT@CK framework technique type: string id: description: Unique identifier of the MITRE ATT@CK framework technique type: string type: object ResponderExecutionCollection: description: 'Collection of aggregated responder execution information, including their corresponding count values. ' properties: items: description: List of ResponderExecutionSummary resources items: $ref: '#/components/schemas/ResponderExecutionSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object CreateDetectorRecipeDetectorRuleSightingTypeDetails: description: Details for creating new sighting type. properties: additionalEntitiesMapping: description: Data source additional entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' maxItems: 15 minItems: 0 type: array dataSourceId: description: Unique identifier of the associated data source type: string description: description: Description of the sighting type type: string displayName: description: Display name of the sighting type type: string tactic: description: MITRE ATT@CK framework tactic associated with a Sighting Type type: string technique: description: MITRE ATT@CK framework technique associated with a Sighting Type type: string required: - displayName - tactic - technique - dataSourceId type: object SightingImpactedResourceCollection: description: Collection of sighting impacted resource summaries. properties: items: description: List of SightingImpactedResourceSummary resources items: $ref: '#/components/schemas/SightingImpactedResourceSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateTargetResponderRecipeResponderRuleDetails: description: Parameters to update a responder rule for a responder recipe attached to a target. properties: details: $ref: '#/components/schemas/UpdateTargetResponderRuleDetails' required: - details type: object ResourceProfileCollection: description: Collection of resource profile summaries. properties: items: description: List of ResourceProfileSummary resources items: $ref: '#/components/schemas/ResourceProfileSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object DetectorRecipeDetectorRuleSummary: description: Summary information for a DetectorRecipeDetectorRule resoource. properties: candidateResponderRules: description: List of responder rules that can be used to remediate problems triggered by this detector rule items: $ref: '#/components/schemas/CandidateResponderRule' type: array dataSourceId: description: The ID of the attached data source type: string description: description: Description of the detector rule type: string detector: description: Possible types of detectors enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorDetails: $ref: '#/components/schemas/DetectorDetails' displayName: description: Display name of the detector rule type: string entitiesMappings: description: Data source entities mapping for the detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array id: description: The unique identifier of the detector rule maxLength: 255 minLength: 1 type: string isCloneable: description: Is the rule cloneable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the detector recipe rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' managedListTypes: description: List of managed list types related to this rule items: enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string type: array recommendation: description: Recommendation for the Display name of the detector rule type: string resourceType: description: Resource type of the configuration to which the rule is applied type: string ruleType: description: Rule type items: $ref: '#/components/schemas/RuleType' type: array serviceType: description: Service type of the configuration to which the rule is applied type: string sourceDetectorRuleId: description: The unique identifier of the source detector rule type: string timeCreated: description: The date and time the detector recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector recipe rule was last updated. Format defined by RFC3339. format: date-time type: string required: - id - detector type: object ResponderExecutionAggregation: description: Provides the dimensions and their corresponding count value. properties: count: description: The number of occurrences with given dimensions type: integer dimensionsMap: additionalProperties: type: string description: The key-value pairs of dimensions and their names. The key corresponds to the Analytic Dimension(s) chosen, and the value corresponds to the value of the dimension from the data. E.g. if the Analytic Dimension chosen is "RISK_LEVEL", then the value will be like "CRITICAL". If the Analytic Dimensions chosen are "RISK_LEVEL" and "RESOURCE_TYPE", then the map will have two key-value pairs of form {"RISK_LEVEL" : "CRITICAL, "RESOURCE_TYPE" : "LOAD_BALANCER"} type: object required: - dimensionsMap - count type: object CreateDataSourceDetails: description: Parameters for creating a data source (DataSource resource). properties: compartmentId: description: Compartment OCID of the data source type: string dataSourceDetails: $ref: '#/components/schemas/DataSourceDetails' dataSourceFeedProvider: description: Type of data source feed provider (LoggingQuery) enum: - LOGGINGQUERY type: string x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detailed description of the data source. type: string displayName: description: Data source display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object status: default: DISABLED description: Enablement status of data source. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataSourceStatus' required: - displayName - compartmentId - dataSourceFeedProvider - dataSourceDetails type: object SightingType: description: Information for a sighting type properties: additionalEntitiesMapping: description: Data source additional entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' maxItems: 15 minItems: 0 type: array dataSourceId: description: Unique identifier of the associated data source type: string description: description: Description of the sighting type type: string displayName: description: Display name of the sighting type type: string id: description: The unique identifier of the sighting type type: string mitreDetails: $ref: '#/components/schemas/MitreDetails' mitreLink: description: MITRE ATT@CK framework link for the sighting type type: string owner: description: Owner type for the sighting type enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' tactic: description: MITRE ATT@CK framework tactic for the sighting type type: string techniques: description: List of MITRE ATT@CK framework techniques for the sighting type items: type: string type: array timeCreated: description: The date and time the sighting type was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the sighting type was updated. Format defined by RFC3339. format: date-time type: string type: object MonitoringResourceCollection: description: The collection of MonitoringResourceSummary resources. properties: items: description: List of MonitoringResourceSummary resources items: $ref: '#/components/schemas/MonitoringResourceSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object CreateTargetResponderRecipeDetails: description: 'Parameters to be used to create a new target responder recipe (TargetDetectorRecipe resource). ' properties: responderRecipeId: description: Unique identifier for responder recipe maxLength: 255 minLength: 1 type: string responderRules: description: List of overrides to be applied to responder rules associated with the target items: $ref: '#/components/schemas/UpdateTargetRecipeResponderRuleDetails' type: array required: - responderRecipeId type: object UpdateTargetResponderRecipe: description: Parameters to update a responder recipe attached to a target properties: responderRules: description: List of responder rules to be updated in the target responder recipe items: $ref: '#/components/schemas/UpdateTargetRecipeResponderRuleDetails' type: array targetResponderRecipeId: description: Unique identifier for the target responder recipe maxLength: 255 minLength: 1 type: string required: - targetResponderRecipeId type: object ResponderConfiguration: description: Details for a configuration to be applied to a responder. properties: configKey: description: Unique identifier of the configuration type: string name: description: Configuration name type: string value: description: Configuration value type: string required: - configKey - name - value type: object SecurityRecipeCollection: description: 'Collection of Security Zones recipes (SecurityRecipeSummary resources), resulting from a security zone recipe search. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object items: description: A list of SecurityRecipeSummary resources items: $ref: '#/components/schemas/SecurityRecipeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - items ChangeDetectorRecipeCompartmentDetails: description: Parameters to use to move a detector recipe to a different compartment. properties: compartmentId: description: The OCID of the compartment into which the detector recipe is to be moved maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateDetectorRecipeDetails: description: Parameters to use to create details for a detector recipe. properties: compartmentId: description: Compartment OCID type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Detector recipe description. Avoid entering confidential information. ' type: string detector: description: Detector for the rule enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRules: description: Detector rules to override from source detector recipe items: $ref: '#/components/schemas/UpdateDetectorRecipeDetectorRule' type: array displayName: description: 'Detector recipe display name. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object sourceDetectorRecipeId: description: The ID of the source detector recipe type: string required: - displayName - compartmentId type: object ResourceLock: description: 'Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string timeCreated: description: When the lock was created, in the format defined by RFC 3339. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object Problem: description: Problems are at the core of Cloud Guard’s functionality. A Problem resource is created whenever an action or a configuration on a resource triggers a rule in a detector that’s attached to the target containing the compartment where the resource is located. Each Problem resource contains all the details for a single problem. This is the information for the problem that appears on the Cloud Guard Problems page. properties: additionalDetails: additionalProperties: type: string description: The additional details of the problem type: object autoResolveDate: description: The date and time when the problem will be auto resolved. Format defined by RFC3339. type: string comment: description: User comments on the problem type: string compartmentId: description: Compartment OCID where the resource is created type: string description: description: Description of the problem type: string detectorId: description: Unique identifier of the detector rule that triggered the problem enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRuleId: description: Unique identifier of the detector rule that triggered the problem type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string impactedResourceId: description: Unique identifier of the resource impacted by the problem type: string impactedResourceName: description: Display name of the impacted resource type: string impactedResourceType: description: Type of the impacted resource type: string labels: description: User-defined labels on the problem items: type: string type: array lifecycleDetail: description: Additional details on the substate of the lifecycle state enum: - OPEN - RESOLVED - DISMISSED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' lifecycleState: description: The current lifecycle state of the problem enum: - ACTIVE - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array peakRiskScore: description: Peak risk score for the problem format: double type: number peakRiskScoreDate: description: The date and time for the peak risk score that is observed for the problem. Format defined by RFC3339. type: string peakRiskScoreLookupPeriodInDays: description: Number of days for which peak score is calculated for the problem type: integer recommendation: description: Recommendation for the problem type: string region: description: DEPRECATED type: string regions: description: Regions where the problem is found items: type: string type: array resourceId: description: Unique identifier of the resource affected by the problem type: string resourceName: description: Display name of the affected resource type: string resourceType: description: Type of the affected resource type: string riskLevel: description: The risk level for the problem enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' riskScore: description: The risk score for the problem format: double type: number targetId: description: Unique identifier of the target associated with the problem type: string timeFirstDetected: description: The date and time the problem was first detected. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: The date and time the problem was last detected. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId type: object TargetResponderRecipeResponderRuleSummary: description: Summary information for a target responder recipe responder rule. properties: compartmentId: description: Compartment OCID type: string description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Responder rule display name type: string id: description: Unique identifier for the responder rule maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' policies: description: List of policies items: type: string type: array supportedModes: description: Supported execution modes for the responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the target responder recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target responder recipe rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - id - compartmentId type: object UpdateTargetRecipeResponderRuleDetails: description: Parameters to update the configuration details of a target detector recipe. properties: details: $ref: '#/components/schemas/UpdateTargetResponderRuleDetails' responderRuleId: description: Unique identifier for target detector recipe maxLength: 255 minLength: 1 type: string required: - responderRuleId - details type: object ResponderRecipeResponderRule: description: 'A ResponderRecipeRule resource contains a specific instance of a single responder rule. A ResponderRecipeRule resource: * Is effectively a copy of a ResponderRule resource in which users can make certain changes if it’s Oracle-managed, and other changes if it’s user-managed. * Can also be created by cloning an existing ResponderRecipe resource, either user-managed or Oracle-managed; cloning the ResponderRecipe resource also clones its associated ResponderRule resources as ResponderRecipeRule resources. * Is visible on the Cloud Guard Responder Recipes, Responder Details page. * Is effectively located in a specific OCI compartment, through the ResponderRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply globally, to all resources in OCI compartments mapped to a target that attaches the associated responder recipe (in a TargetResponderRecipe resource), but are overridden by changes made in the corresponding TargetResponderRecipe resource (which is effectively a copy of the ResponderRecipe resource). type: object ' properties: compartmentId: description: Compartment OCID type: string description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Responder rule display name type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array policies: description: List of policies items: type: string type: array responderRuleId: description: Unique identifier for the responder rule maxLength: 255 minLength: 1 type: string supportedModes: description: Supported execution modes for the responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the responder recipe rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder recipe rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - responderRuleId - compartmentId ResponderExecution: description: Attributes for a responder execution (ResponderExecution resource). properties: compartmentId: description: Compartment OCID of the responder execution for the problem type: string id: description: The unique identifier of the responder execution maxLength: 255 minLength: 1 type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array message: description: Message about the responder execution type: string problemId: description: Problem ID associated with the responder execution maxLength: 255 minLength: 1 type: string region: description: Region where the problem is found type: string resourceName: description: Resource name of the problem for the responder execution. maxLength: 255 minLength: 1 type: string resourceType: description: Resource type of the problem for the responder execution type: string responderExecutionMode: description: Execution mode of the responder enum: - MANUAL - AUTOMATED - ALL type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionModes' responderExecutionStatus: description: Current execution status of the responder enum: - STARTED - AWAITING_CONFIRMATION - AWAITING_INPUT - SUCCEEDED - FAILED - SKIPPED - ALL type: string x-obmcs-top-level-enum: '#/definitions/ResponderExecutionStates' responderRuleExecutionDetails: $ref: '#/components/schemas/ResponderRuleExecutionDetails' responderRuleId: description: Responder rule ID for the responder execution type: string responderRuleName: description: Responder rule name for the responder execution maxLength: 255 minLength: 1 type: string responderRuleType: description: Responder rule type for the responder execution enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' targetId: description: Target ID of the problem for the responder execution maxLength: 255 minLength: 1 type: string timeCompleted: description: The date and time the responder execution was updated. Format defined by RFC3339. format: date-time type: string timeCreated: description: The date and time the responder execution was created. Format defined by RFC3339. format: date-time type: string required: - id - responderRuleId - responderRuleType - responderRuleName - problemId - region - targetId - compartmentId - resourceType - resourceName - responderExecutionMode - responderExecutionStatus - timeCreated type: object SightingSummary: description: Sighting summary definition. properties: actorPrincipalId: description: Unique identifier for principal actor type: string actorPrincipalName: description: Name of principal actor type: string actorPrincipalType: description: Type of principal actor type: string classificationStatus: description: Classification status of the sighting enum: - FALSE_POSITIVE - TRUE_POSITIVE - NOT_CLASSIFIED - BENIGN_TRUE_POSITIVE type: string x-obmcs-top-level-enum: '#/definitions/ClassificationStatus' compartmentId: description: Compartment OCID where the impacted resource is created type: string confidence: description: Confidence level that the sighting is not a false positive enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Confidence' detectorRuleId: description: Unique identifier of the detector rule that was triggered type: string id: description: Unique identifier for sighting type: string problemId: description: Problem ID associated with sighting type: string regions: description: List of regions involved in the sighting items: type: string type: array uniqueItems: true severity: description: Severity of the sighting enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Severity' sightingScore: description: Score for the sighting type: integer sightingType: description: Type of sighting type: string sightingTypeDisplayName: description: Display name of the sighting type type: string tacticName: description: Name of the MITRE ATT@CK framework tactic type: string techniqueName: description: Name of the MITRE ATT@CK framework technique type: string timeFirstDetected: description: Time the activities were first detected. Format defined by RFC3339. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: Time the activities were last detected. Format defined by RFC3339. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. Format defined by RFC3339. format: date-time type: string required: - id - sightingType - sightingTypeDisplayName - compartmentId - detectorRuleId - regions - tacticName - techniqueName - severity - confidence - sightingScore - classificationStatus - timeFirstDetected - timeLastDetected type: object ResponderRecipeCollection: description: Collection of responder recipe summary information. properties: items: description: List of ResponderRecipeSummary resources items: $ref: '#/components/schemas/ResponderRecipeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object DetectorRecipe: description: A detector recipe is a collection of rules that can be configured to trigger problems that appear on the Cloud Guard Problems page. A DetectorRecipe resource contains settings for a specific detector recipe, plus a list of the detector rules (DetectorRecipeDetectorRule resources) belonging to the DetectorRecipe resource. properties: compartmentId: description: Compartment OCID of detector recipe type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detector recipe description type: string detector: description: Type of detector enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRecipeType: description: Recipe type ( STANDARD, ENTERPRISE ) enum: - LIMITED - BASIC - STANDARD - ENTERPRISE type: string x-obmcs-top-level-enum: '#/definitions/DetectorRecipeEnum' detectorRules: description: List of detector rules for the detector type for recipe - user input items: $ref: '#/components/schemas/DetectorRecipeDetectorRule' type: array displayName: description: Display name of detector recipe type: string effectiveDetectorRules: description: List of effective detector rules for the detector type for recipe after applying defaults items: $ref: '#/components/schemas/DetectorRecipeDetectorRule' type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: OCID for detector recipe maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: Owner of detector recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' sourceDataRetention: description: The number of days for which source data is retained type: integer sourceDetectorRecipeId: description: Recipe OCID of the source recipe to be cloned type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetIds: description: List of target IDs to which the recipe is attached items: type: string type: array timeCreated: description: The date and time the detector recipe was created Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the detector recipe was last updated Format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - owner - detector - sourceDetectorRecipeId type: object ProblemEntitySummary: description: Summary information about problem entities for a data source for a problem. properties: entityDetails: description: List of entity details related to a data source items: $ref: '#/components/schemas/EntityDetails' type: array problemId: description: Attached problem ID type: string regions: description: Data source problem entities region items: type: string type: array resultUrl: description: Log result query URL for a data source query type: string timeFirstDetected: description: Data source problem entities first detected time format: date-time type: string timeLastDetected: description: Data source problem entities last detected time format: date-time type: string required: - regions - problemId - timeFirstDetected - timeLastDetected type: object ProblemAggregationCollection: description: A collection of problem aggregation data for problem analytics. properties: items: description: List of all the ProblemAggregation resources items: $ref: '#/components/schemas/ProblemAggregation' type: array required: - items type: object DetectorDetails: description: Detailed information for a detector. properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of detector rule configurations items: $ref: '#/components/schemas/DetectorConfiguration' type: array dataSourceId: description: The ID of the attached data source type: string description: description: Description for detector recipe detector rule type: string entitiesMappings: description: Data source entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array isConfigurationAllowed: description: Can the rule be configured? type: boolean isEnabled: description: Enablement status for the rule type: boolean labels: description: User-defined labels for a detector rule items: type: string type: array problemThreshold: description: The point at which an elevated resource risk score creates a problem type: integer recommendation: description: Recommendation for detector recipe detector rule type: string riskLevel: description: The risk level for the rule enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' sightingTypes: description: List of sighting types items: $ref: '#/components/schemas/SightingType' type: array targetTypes: description: List of target types for which the detector rule is applicable items: type: string type: array required: - isEnabled type: object MitreTechniqueSummary: description: Summary information for a MITRE ATT@CK framework technique. properties: displayName: description: Display name of the technique type: string id: description: Unique identifier for the technique maxLength: 255 minLength: 1 type: string mitreLink: description: MITRE ATT@CK framework URL of the technique type: string required: - id - displayName - mitreLink type: object TargetCollection: description: Collection of summary information for targets. properties: items: description: List of TargetSummary resources items: $ref: '#/components/schemas/TargetSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateDetectorRuleDetails: description: Parameters to be updated for a detector rule within a detector recipe. properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of detector rule configurations items: $ref: '#/components/schemas/DetectorConfiguration' type: array dataSourceId: description: The unique identifier of the attached data source type: string description: description: Description for the detector rule type: string detectorRuleResourceType: description: Resource type for Threat Detector rule enum: - USER - COMPUTE_INSTANCE - OTHER_OCI_RESOURCE - EXTERNAL_IP - INTERNAL_IP - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DetectorRuleResourceType' detectorRuleResourceTypeName: description: Resource type name for Threat Detector rule type: string entitiesMappings: description: Data source entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array isEnabled: description: Enablement status of the detector rule type: boolean labels: description: User-defined labels for a detector rule items: type: string type: array recommendation: description: Recommendation for the detector rule type: string riskLevel: description: The risk level of the detector rule enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' required: - isEnabled type: object ProblemSummary: description: Summary information for a problem. properties: compartmentId: description: Compartment OCID where the resource is created type: string detectorId: description: Unique identifier of the detector associated with the problem enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRuleId: description: Unique identifier of the detector rule type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string labels: description: User-defined labels on the problem items: type: string type: array lifecycleDetail: description: Additional details on the substate of the lifecycle state enum: - OPEN - RESOLVED - DISMISSED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' lifecycleState: description: The current lifecycle state of the problem enum: - ACTIVE - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array region: description: DEPRECATED type: string regions: description: List of regions where the problem is found items: type: string type: array resourceId: description: Unique identifier of the resource that's impacted by the problem type: string resourceName: description: Display name of the resource impacted by the problem type: string resourceType: description: Type of the resource impacted by the problem type: string riskLevel: description: The risk level of the problem enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' riskScore: description: The risk score for the problem format: double type: number targetId: description: Unique target identifier associated with the problem type: string timeFirstDetected: description: The date and time the problem was first detected. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: The date and time the problem was last detected. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId type: object TriggerResponderDetails: description: The responder triggering details to be pushed to responder rules. properties: configurations: description: List of responder rule configurations items: $ref: '#/components/schemas/ResponderConfiguration' type: array responderRuleId: description: Unique identifier for the responder rule type: string required: - responderRuleId type: object RuleType: description: The detector rule types. properties: key: description: The unique identifier of the detector rule type enum: - CATEGORY type: string value: description: Detector rule type value items: type: string type: array required: - key - value type: object ResponderRuleExecutionDetails: description: Details of responder rule execution for a problem. properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of responder rule configurations items: $ref: '#/components/schemas/ResponderConfiguration' type: array type: object WorkRequestLogEntryCollection: description: 'The collection of work request log entries. These result from a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. ' properties: items: description: List of workRequestLogEntry resources items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object ManagedListSummary: description: Summary information for a managed list. properties: compartmentId: description: Compartment OCID where the resource is created type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Managed list description type: string displayName: description: Managed list display name type: string feedProvider: description: Provider of the feed enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/FeedProviderType' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object group: description: Managed list type group type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string isEditable: description: Is this list editable? type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] type: string listItems: description: List of items in the managed list items: type: string type: array listType: description: Type of information stored in the managed list enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string x-obmcs-top-level-enum: '#/definitions/ManagedListType' sourceManagedListId: description: OCID of the source managed list type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the managed list was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the managed list was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - displayName - listType - listItems - feedProvider ManagedListTypeSummary: description: A managed list type summary (ManagedListTypeSummary object) contains summary information for a managed list type (ManagedListType object). properties: description: description: Managed list type description type: string group: description: Managed list type group type: string id: description: Unique identifier for a managed list type maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - id type: object SecurityScoreAggregationCollection: description: Collection of security score aggregation information. properties: items: description: List of all the SecurityScoreAggregation resources objects. items: $ref: '#/components/schemas/SecurityScoreAggregation' type: array required: - items type: object DataSourceMappingInfo: description: Details of the detector recipe and detector rule mapped to the data source. properties: detectorRecipeId: description: ID of the detector recipe attached to the data source type: string detectorRuleId: description: ID of the detector rule attached to the data source type: string sightingTypeId: description: ID of the sighting type attached to the data source type: string required: - detectorRecipeId - detectorRuleId type: object ProblemTrendAggregationCollection: description: Collection of problem trend aggregations properties: items: description: List of problem trend aggregations (ProblemTrendAggregation resources) items: $ref: '#/components/schemas/ProblemTrendAggregation' type: array required: - items type: object SecurityPolicy: description: 'A security policy (SecurityPolicy resource) defines security requirements for resources in a security zone. If a security zone enables a security policy through a security recipe (SecurityRecipe resource), then any action that would violate that policy is blocked. ' properties: category: description: The category of the security policy type: string compartmentId: description: The OCID of the security policy's compartment type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security policy's description type: string displayName: description: The security policy's display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object friendlyName: description: A shorter version of the security policy's name type: string id: description: Unique identifier that can’t be changed after creation type: string lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a resource in a `Failed` state. type: string lifecycleState: description: The current lifecycle state of the security policy enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array owner: description: The owner of the security policy enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' services: description: The list of services that the security policy protects items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the security policy was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the security policy was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - owner type: object CredentialsValidationDetails: description: 'A collection of CredentialValidationDetailsItem resources. This resource contains details about the result of the credential validation call. For example, it contains the URL, response status and response code. ' properties: items: description: List of credentials validation responses (CredentialsValidationDetailsItem resources) items: $ref: '#/components/schemas/CredentialsValidationDetailsItem' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object DataSourceCollection: description: The collection of data source summaries (DataSourceSummary resources). properties: items: description: List of data source summaries (DataSourceSummary resources) items: $ref: '#/components/schemas/DataSourceSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object MitreDetails: description: MITRE ATT@CK framework details for the sighting type. properties: tacticDetails: $ref: '#/components/schemas/MitreTactic' techniqueDetails: $ref: '#/components/schemas/MitreTechnique' type: object UpdateTargetResponderRecipeDetails: description: 'Parameters to update a responder recipe attached to a target. UpdateTargetResponderRecipe contains the responder rules to be updated that are associated with a responder recipe in a target. whereas UpdateTargetResponderRecipeDetails refers to the information to be updated in ResponderRecipe. ' properties: responderRules: description: List of responder rules to be updated in a target responder recipe. items: $ref: '#/components/schemas/UpdateTargetRecipeResponderRuleDetails' type: array required: - responderRules type: object ProblemHistoryCollection: description: Collection of problem history summary information. properties: items: description: List of ProblemHistorySummary resources items: $ref: '#/components/schemas/ProblemHistorySummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object CreateDetectorRuleDetails: description: Details of a detector rule to be created in a detector recipe. properties: condition: $ref: '#/components/schemas/Condition' configurations: description: List of detector rule configurations items: $ref: '#/components/schemas/DetectorConfiguration' maxItems: 100 minItems: 0 type: array uniqueItems: true dataSourceId: description: OCID of the data source which is attached type: string description: description: Description of the detector rule type: string detectorRuleResourceType: description: Resource type for Threat Detector rule. enum: - USER - COMPUTE_INSTANCE - OTHER_OCI_RESOURCE - EXTERNAL_IP - INTERNAL_IP - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/DetectorRuleResourceType' detectorRuleResourceTypeName: description: Resource type name for Threat Detector rule type: string entitiesMappings: description: Data source entities mapping for the detector rule items: $ref: '#/components/schemas/EntitiesMapping' type: array isEnabled: default: false description: Enablement state of the detector rule type: boolean labels: description: User-defined labels for the detector rule items: maxItems: 20 minItems: 0 type: string type: array name: description: Name of the detector rule type: string recommendation: description: Recommendations for the detector rule type: string riskLevel: description: The risk level for the detector rule enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' sourceDetectorRuleId: description: ID of source detector rule type: string required: - name type: object DataSourceSummaryDetails: description: Summary information for a data source of a specified data source type. discriminator: propertyName: dataSourceFeedProvider properties: dataSourceFeedProvider: description: Possible type of data source feed provider(LoggingQuery) enum: - LOGGINGQUERY type: string x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' required: - dataSourceFeedProvider ConditionGroup: description: Details for a condition configured on a target. properties: compartmentId: description: Compartment OCID associated with condition type: string condition: $ref: '#/components/schemas/Condition' required: - compartmentId - condition type: object UpdateResponderRecipeResponderRuleDetails: description: Parameters to use to update a responder rule within a responder recipe. properties: details: $ref: '#/components/schemas/UpdateResponderRuleDetails' required: - details type: object SecurityRecipeSummary: description: Summary information for a Security Zones recipe. properties: compartmentId: description: The OCID of the compartment that contains the recipe type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The recipe's description type: string displayName: description: The recipe's name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier that can't be changed after creation type: string lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the recipe enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' owner: description: The owner of the recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' securityPolicies: description: The list of security policy IDs that are included in the recipe items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the recipe was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the recipe was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - securityPolicies - owner type: object UpdateResponderRecipeResponderRule: description: Parameters to use to update a responder recipe responder rule. properties: details: $ref: '#/components/schemas/UpdateResponderRuleDetails' responderRuleId: description: Unique identifier for the responder rule type: string required: - responderRuleId - details type: object CreateManagedListDetails: description: Parameters to use to create details for a new managed list. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Managed list description Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string displayName: description: 'Managed list display name. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object group: description: Managed list type group type: string listItems: description: List of items in the managed list items: type: string maxLength: 200 minLength: 1 type: array listType: description: Type of information stored in the list enum: - CIDR_BLOCK - USERS - GROUPS - IPV4ADDRESS - IPV6ADDRESS - RESOURCE_OCID - REGION - COUNTRY - STATE - CITY - TAGS - GENERIC - FUSION_APPS_ROLE - FUSION_APPS_PERMISSION - NAMESPACE_SELECTOR - POD_RESOURCE_SELECTOR type: string x-obmcs-top-level-enum: '#/definitions/ManagedListType' sourceManagedListId: description: OCID of the source managed list type: string required: - displayName - compartmentId EntitiesMapping: description: Parameters for entities mapping to data source. properties: displayName: description: Display name of the entity type: string entityType: description: Type of entity enum: - EXTERNAL_IP - INTERNAL_IP - TEXT - JSON_LIST type: string x-obmcs-top-level-enum: '#/definitions/EntityType' queryField: description: The entity value mapped to a data source query type: string required: - queryField type: object AddCompartmentDetails: description: Parameter for an existing compartment to be added to a security zone. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to be added to the security zone. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ResponderRuleSummary: description: Summary information for a responder rule. properties: description: description: Responder rule description type: string details: $ref: '#/components/schemas/ResponderRuleDetails' displayName: description: Display name for responder rule type: string id: description: Unique identifier for responder rule maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the responder rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' policies: description: List of policies items: type: string type: array supportedModes: description: Supported execution modes for responder rule items: enum: - AUTOACTION - USERACTION type: string type: array timeCreated: description: The date and time the responder rule was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the responder rule was last updated. Format defined by RFC3339. format: date-time type: string type: description: Type of responder enum: - REMEDIATION - NOTIFICATION type: string x-obmcs-top-level-enum: '#/definitions/ResponderType' required: - id - displayName - description - type type: object ConditionOperator: description: Conditions related to the parameter data type. properties: displayName: description: Display name of the operator type: string name: description: Operator name enum: - AND - OR - IN - NOT_IN - EQUALS - NOT_EQUALS - LESS_THAN - GREATER_THAN - RANGE type: string x-obmcs-top-level-enum: '#/definitions/ConditionOperatorName' required: - name - displayName Target: description: 'A target defines the scope of resources that Cloud Guard monitors and the rules to be enforced in that monitoring. A Target resource contains the settings for a specific target. ' properties: compartmentId: description: Compartment OCID where the resource is created type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The target description type: string displayName: description: Target display name type: string doesEmitProblemsToEvents: description: Do problems in target's compartments emit OCI events? type: boolean freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string inheritedByCompartments: description: List of inherited compartments items: maxLength: 255 minLength: 1 type: string type: array lifecycleDetails: description: A message describing the current lifecycle state in more detail. For example, can be used to provide actionable information for a resource in Failed state. maxLength: 50 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the target enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' lifecyleDetails: description: A message describing the current lifecycle state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] type: string recipeCount: description: Total number of recipes attached to target type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDetails: $ref: '#/components/schemas/TargetDetails' targetDetectorRecipes: description: List of detector recipes attached to target items: $ref: '#/components/schemas/TargetDetectorRecipe' type: array targetResourceId: description: Resource ID which the target uses to monitor type: string targetResourceType: description: Type of target enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/TargetResourceType' targetResponderRecipes: description: List of responder recipes attached to target items: $ref: '#/components/schemas/TargetResponderRecipe' type: array timeCreated: description: The date and time the target was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - targetResourceId - targetResourceType - recipeCount TargetSummaryAdditionalDetails: description: A summary of additional details of a target. discriminator: propertyName: targetResourceType properties: targetResourceType: description: Type of resource that's asspcoated with the target enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/TargetResourceType' required: - targetResourceType ResourceProfile: description: Resource profile details. properties: compartmentId: description: Compartment OCID for the resource profile type: string displayName: description: Display name for the resource profile type: string id: description: Unique identifier for the resource profile type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array peakRiskScore: description: Peak risk score for the resource profile format: double type: number problemIds: description: List of problems IDs associated with the resource profile items: type: string maxItems: 20 minItems: 1 type: array uniqueItems: true resourceId: description: Unique identifier for the resource associated with the resource profile type: string riskLevel: description: Risk level associated with resource profile enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' riskScore: description: Risk score for the resource profile format: double type: number sightingsCount: description: Number of sightings associated with the resource profile type: integer tactics: description: List of tactic summaries associated with the resource profile items: $ref: '#/components/schemas/TacticSummary' type: array uniqueItems: true targetId: description: Unique target ID for the resource profile type: string timeFirstDetected: description: Time the activities were first detected. Format defined by RFC3339. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: Time the activities were last detected. Format defined by RFC3339. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. Format defined by RFC3339. format: date-time type: string timePeakScore: description: The date and time for the peak risk score. Format defined by RFC3339. format: date-time type: string type: description: Resource type for the resource profile type: string required: - id - resourceId - displayName - type - tactics - compartmentId - riskScore - timeFirstDetected - timeLastDetected type: object ProblemHistorySummary: description: Problem history definition. properties: actorName: description: Resource name who performed the activity type: string actorType: description: Type of actor who performed the operation enum: - CLOUD_GUARD_SERVICE - CORRELATION - RESPONDER - USER type: string x-obmcs-top-level-enum: '#/definitions/ActorType' comment: description: User-defined comments type: string delta: description: Impacted resource names in a comma-separated string type: string eventStatus: description: Event status enum: - REOPEN - OPEN - UPDATE - RESOLVE - DISMISS - DELETE type: string x-obmcs-top-level-enum: '#/definitions/EventStatus' explanation: description: Activity explanation details maxLength: 255 minLength: 0 type: string id: description: Unique identifier for the history record maxLength: 255 minLength: 1 type: string lifecycleDetail: description: Additional details on the substate of the lifecycle state enum: - OPEN - RESOLVED - DISMISSED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/ProblemLifecycleDetail' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array problemId: description: Problem ID with which history is associated type: string timeCreated: description: Date and time the problem was created format: date-time type: string required: - id - problemId - actorType - actorName - explanation - lifecycleDetail - timeCreated - delta type: object MitreTechniqueCollection: description: Collection of summaries for MITRE ATT@CK framework techniques supported by Cloud Guard. properties: items: description: List of MitreTechniqueSummary resources items: $ref: '#/components/schemas/MitreTechniqueSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object MitreTactic: description: MITRE ATT@CK framework tactic properties: displayName: description: The display name of MITRE ATT@CK framework tactic type: string id: description: The unique identifier of MITRE ATT@CK framework tactic type: string type: object DataSourceSummary: description: Summary information for a specific data source. properties: compartmentId: description: Compartment OCID of the data source type: string dataSourceFeedProvider: description: Type of data source feed provider(LoggingQuery) enum: - LOGGINGQUERY type: string x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' dataSourceSummaryDetails: $ref: '#/components/schemas/DataSourceSummaryDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detailed description of the data source. type: string displayName: description: Display name of the data source type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: OCID for the data source maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' loggingQueryDetails: $ref: '#/components/schemas/LoggingQueryDetails' status: description: Status of data source enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DataSourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the data source was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the data source was updated. Format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - dataSourceFeedProvider type: object ResponderActivityCollection: description: Provides a summary of responder activities and their corresponding count values. properties: items: description: List of ResponderActivitySummary resources items: $ref: '#/components/schemas/ResponderActivitySummary' type: array required: - items type: object DetectorRuleCollection: description: Summary information for the collection of detector rules. properties: items: description: List of DetectorRuleSummary resources items: $ref: '#/components/schemas/DetectorRuleSummary' type: array required: - items type: object UpdateDetectorRecipeDetectorRuleSightingTypeDetails: description: Details for updating a sighting type. properties: additionalEntitiesMapping: description: Data source additional entities mapping for a detector rule items: $ref: '#/components/schemas/EntitiesMapping' maxItems: 15 minItems: 0 type: array dataSourceId: description: Unique identifier of associated data source type: string description: description: Description of the sighting type type: string displayName: description: Name of the sighting type type: string tactic: description: MITRE ATT@CK framework tactic associated with a sighting Type type: string technique: description: MITRE ATT@CK framework technique associated with a sighting type type: string type: object TargetDetectorRecipeSummary: description: Summary information for a target detector recipe properties: compartmentId: description: Compartment OCID type: string description: description: Detector recipe's description type: string detector: description: Type of detector enum: - IAAS_ACTIVITY_DETECTOR - IAAS_CONFIGURATION_DETECTOR - IAAS_THREAT_DETECTOR - IAAS_LOGGING_DETECTOR - IAAS_LOG_INSIGHT_DETECTOR - SAAS_FA_ACTIVITY_DETECTOR - IAAS_CONTAINER_SECURITY_DETECTOR type: string x-obmcs-top-level-enum: '#/definitions/DetectorEnum' detectorRecipeId: description: Unique identifier for detector recipe of which this is an extension type: string detectorRecipeType: description: Recipe type ( STANDARD, ENTERPRISE ) enum: - LIMITED - BASIC - STANDARD - ENTERPRISE type: string x-obmcs-top-level-enum: '#/definitions/DetectorRecipeEnum' displayName: description: Detector recipe's display name type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the resource enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array owner: description: Detector recipe's owner enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' sourceDataRetention: description: The number of days for which source data is retained type: integer timeCreated: description: The date and time the target detector recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target detector recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - detectorRecipeId - displayName - description - owner type: object SightingCollection: description: Collection of sighting summaries. properties: items: description: List of SightingSummary resources items: $ref: '#/components/schemas/SightingSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateResponderRecipeDetails: description: Parameters to use to update a responder recipe. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Responder recipe description Avoid entering confidential information. ' type: string displayName: description: 'Responder recipe display name. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object responderRules: description: List of responder rules to update items: $ref: '#/components/schemas/UpdateResponderRecipeResponderRule' type: array required: - displayName type: object DataSourceDetails: description: Details specific to the data source type. discriminator: propertyName: dataSourceFeedProvider properties: dataSourceFeedProvider: description: Type of data source feed provider (LoggingQuery) enum: - LOGGINGQUERY type: string x-obmcs-top-level-enum: '#/definitions/DataSourceFeedProvider' required: - dataSourceFeedProvider ConditionMetadataTypeCollection: description: The collection of available condition types. properties: items: description: List of ConditionMetadataTypeSummary resources items: $ref: '#/components/schemas/ConditionMetadataTypeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object CreateTargetDetails: description: Parameters used to create a new target. properties: compartmentId: description: Compartment OCID where the resource is created type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The target description. Avoid entering confidential information. ' type: string displayName: description: 'Display name for the target. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string doesEmitProblemsToEvents: description: Should problems be emitted to OCI Events service? type: boolean freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object lifecycleState: description: The enablement state of the detector rule enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' targetDetectorRecipes: description: List of detector recipes to attach to target items: $ref: '#/components/schemas/CreateTargetDetectorRecipeDetails' type: array targetResourceId: description: Resource ID which the target uses to monitor type: string targetResourceType: description: Type of resource that target support (COMPARTMENT/FACLOUD) enum: - COMPARTMENT - ERPCLOUD - HCMCLOUD - FACLOUD - SECURITY_ZONE type: string x-obmcs-top-level-enum: '#/definitions/TargetResourceType' targetResponderRecipes: description: List of responder recipes to attach to target items: $ref: '#/components/schemas/CreateTargetResponderRecipeDetails' type: array required: - displayName - compartmentId - targetResourceId - targetResourceType type: object TargetDetectorRecipeCollection: description: Collection of target detector recipe summaries. properties: items: description: List of TargetDetectorRecipeSummary resources items: $ref: '#/components/schemas/TargetDetectorRecipeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object UpdateDetectorRecipeDetails: description: Parameters to use to update details for a detector recipe. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'Detector recipe description. Avoid entering confidential information. ' type: string detectorRules: description: List of detector rules to update items: $ref: '#/components/schemas/UpdateDetectorRecipeDetectorRule' type: array displayName: description: 'Display name of detector recipe. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object type: object CredentialsDetailsItem: description: Details for the credentials to be validated. properties: password: description: Service password format: password maxLength: 255 minLength: 1 type: string serviceType: description: Type of service enum: - FA - OAM type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' url: description: URL of service maxLength: 255 minLength: 1 type: string username: description: Service user name maxLength: 255 minLength: 1 type: string required: - serviceType type: object SecurityScoreTrendAggregationCollection: description: Collection of security trend aggregation information. properties: items: description: List of all the SecurityScoreTrendAggregation resources items: $ref: '#/components/schemas/SecurityScoreTrendAggregation' type: array required: - items type: object DetectorRecipeDetectorRuleSightingTypeCollection: description: Collection of sighting type summaries for detector rules. properties: items: description: List of SightingTypeSummary resources items: $ref: '#/components/schemas/DetectorRecipeDetectorRuleSightingTypeSummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object TargetMonitoringSignalSummary: description: 'Summary information for a target monitoring signal (TargetMonitoringSignal resource). ' properties: additionalDetails: additionalProperties: type: string description: The additional details of the monitoring signal type: object compartmentId: description: Compartment ID associated with monitoring signal maxLength: 511 minLength: 1 type: string resourceName: description: Name of resource maxLength: 511 minLength: 1 type: string scanStatus: description: Scan status of resource maxLength: 511 minLength: 1 type: string severity: description: Severity of error of associated resource maxLength: 511 minLength: 1 type: string targetId: description: Target ID associated with monitoring signal maxLength: 511 minLength: 1 type: string tenantId: description: Tenant ID associated with monitoring signal maxLength: 255 minLength: 1 type: string timeLastSuccessful: description: The latest timestamp of fetched signal in a successful run format: date-time type: string type: object UpdateSecurityRecipeDetails: description: Parameters to be used to update a Security Zones security recipe. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The recipe's description maxLength: 511 minLength: 1 type: string displayName: description: The recipe's display name maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object securityPolicies: description: The list of security policy IDs to include in the recipe items: maxLength: 255 minLength: 1 type: string type: array required: - displayName type: object PoliticalLocation: description: The geographical location of a problem in terms of political units. properties: city: description: City of problem's location type: string country: description: Country of problem's location type: string state: description: State or province of problem's location type: string required: - city - state - country type: object TargetResponderRecipeSummary: description: Summary information for a target responder recipe. properties: compartmentId: description: Compartment OCID type: string description: description: Description of the responder recipe type: string displayName: description: Display name of the responder recipe type: string id: description: Unique identifier that can't be changed after creation maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the example enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array owner: description: Owner of the responder recipe enum: - CUSTOMER - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/OwnerType' responderRecipeId: description: Unique identifier for responder recipe of which this is an extension type: string timeCreated: description: The date and time the target responder recipe was created. Format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the target responder recipe was last updated. Format defined by RFC3339. format: date-time type: string required: - id - compartmentId - responderRecipeId - displayName - description - owner type: object CreateSecurityZoneDetails: description: Parameters to be used to create a new security zone. properties: compartmentId: description: The OCID of the compartment for the security zone maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security zone's description maxLength: 511 minLength: 1 type: string displayName: description: The security zone's display name maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object isInheritanceAfterDeleteEnabled: default: true description: Indicates if upon deletion of the security zone the comparment should inherit parent security zone type: boolean securityZoneRecipeId: description: The OCID of the security zone recipe (`SecurityRecipe` resource) for the security zone maxLength: 255 minLength: 1 type: string required: - displayName - securityZoneRecipeId - compartmentId type: object SecurityZone: description: 'A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone''s compartment (and any subcompartments in the zone) that violate a policy are denied. ' properties: compartmentId: description: The OCID of the compartment for the security zone type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The security zone's description type: string displayName: description: The security zone's display name type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object id: description: Unique identifier that can’t be changed after creation type: string inheritedByCompartments: description: List of inherited compartments items: maxLength: 255 minLength: 1 type: string type: array isInheritanceAfterDeleteEnabled: default: true description: Indicates if upon deletion of the security zone the comparment should inherit parent security zone type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state. type: string lifecycleState: description: The current lifecycle state of the security zone enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' securityZoneRecipeId: description: The OCID of the recipe (`SecurityRecipe` resource) for the security zone type: string securityZoneTargetId: description: The OCID of the target associated with the security zone type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the security zone was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the security zone was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - securityZoneRecipeId type: object WorkRequestErrorCollection: description: 'The collection of work request error resources. These result from a workRequestError search. Contains WorkRequestError items and other information, such as metadata. ' properties: items: description: List of workRequestError resources items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object TargetSelected: description: Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId). discriminator: propertyName: kind properties: kind: description: Kind of target selection to be used enum: - ALL - TARGETTYPES - TARGETIDS type: string required: - kind TargetDetectorDetails: description: Overriden settings of a detector rule in recipe attached to target. properties: conditionGroups: description: Condition group corresponding to each compartment items: $ref: '#/components/schemas/ConditionGroup' type: array configurations: description: List of detector rule configurations items: $ref: '#/components/schemas/DetectorConfiguration' type: array isConfigurationAllowed: description: Configuration allowed or not type: boolean isEnabled: description: Enablement state of the detector rule type: boolean labels: description: User-defined labels for a detector rule items: type: string type: array problemThreshold: description: Point at which an elevated resource risk score creates a problem type: integer riskLevel: description: The risk level of the detector rule enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/RiskLevel' sightingTypes: description: List of sighting types items: $ref: '#/components/schemas/SightingType' type: array targetTypes: description: List of target types for which the detector rule is applicable items: type: string type: array required: - isEnabled type: object AttachTargetResponderRecipeDetails: description: 'Identifier for an existing detector recipe to use to create a new detector recipe (TargetDetectorRecipe resource) to be attached to a target. ' properties: responderRecipeId: description: Unique identifier for existing responder recipe maxLength: 255 minLength: 1 type: string required: - responderRecipeId type: object Sighting: description: Sighting details. properties: actorPrincipalId: description: Unique identifier for principal actor type: string actorPrincipalName: description: Name of the principal actor type: string actorPrincipalType: description: Type of the principal actor type: string additionalDetails: additionalProperties: type: string description: The additional details for the sighting type: object classificationStatus: description: Classification status of the sighting enum: - FALSE_POSITIVE - TRUE_POSITIVE - NOT_CLASSIFIED - BENIGN_TRUE_POSITIVE type: string x-obmcs-top-level-enum: '#/definitions/ClassificationStatus' compartmentId: description: Compartment OCID where the resource is created type: string confidence: description: Level of confidence that the sighting is not a false positive enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Confidence' description: description: Description of the sighting type: string id: description: Unique identifier for the sighting type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array problemId: description: Problem ID associated the sighting type: string regions: description: List of regions involved in the sighting items: type: string type: array uniqueItems: true severity: description: Severity of the sighting enum: - CRITICAL - HIGH - MEDIUM - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Severity' sightingScore: description: Score for the sighting type: integer sightingType: description: Type of sighting type: string sightingTypeDisplayName: description: Display name of the sighting type type: string tacticName: description: Name of the MITRE ATT@CK framework tactic type: string techniqueName: description: Name of the MITRE ATT@CK framework technique type: string timeFirstDetected: description: Time the activities were first detected. Format defined by RFC3339. format: date-time type: string timeFirstOccurred: description: Time the activities were first performed. Format defined by RFC3339. format: date-time type: string timeLastDetected: description: Time the activities were last detected. Format defined by RFC3339. format: date-time type: string timeLastOccurred: description: Time the activities were last performed. Format defined by RFC3339. format: date-time type: string required: - id - description - sightingType - sightingTypeDisplayName - compartmentId - regions - tacticName - techniqueName - severity - confidence - sightingScore - classificationStatus - timeFirstDetected - timeLastDetected type: object MitreTacticCollection: description: Collection of summary information for MITRE ATT@CK framework tactics supported by Cloud Guard. properties: items: description: List of MITRE ATT@CK framework tactic summaries items: $ref: '#/components/schemas/MitreTacticSummary' type: array required: - items type: object PolicyCollection: description: Collection of policy statements required by Cloud Guard. properties: items: description: List of global policy statements items: $ref: '#/components/schemas/PolicySummary' type: array locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` Avoid entering confidential information. ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. Avoid entering confidential information. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.oci.cloudguard