Merge pull request #4 from rapid7/release/6.5.19

release/6.5.19 - changes based on console version 6.5.19

Author: zyoutz-r7

api-files/console-swagger-6.5.19.json

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** | The identifier of the vulnerability to which the exception applies. | [optional] 
+**id** | **int** | The identifier of the scope type to which the exception applies. For example in a site scoped vulnerability exception this is the site id, in an asset group vulnerability exception this is the asset group id. | [optional] 
 **key** | **str** | If the scope type is `\"Instance\"`, an optional key to discriminate the instance the exception applies to. | [optional] 
 **links** | [**list[Link]**](Link.md) |  | [optional] 
 **port** | **int** | If the scope type is `\"Instance\"` and the vulnerability is detected on a service, the port on which the exception applies. | [optional] 

docs/ExceptionScope.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **dynamic_discovery** | **bool** | Whether dynamic discovery sources may be used. | [optional] 
 **early_access** | **bool** | Whether early-access features are available prior to general availability. | [optional] 
 **engine_pool** | **bool** | Whether scan engine pools may be used. | [optional] 
-**insight_platform** | **bool** | Whether the usage of the Insight Platform is allowed. | [optional] 
+**insight_platform** | **bool** | Whether the usage of the Insight platform is allowed. | [optional] 
 **mobile** | **bool** | Whether mobile features are allowed. | [optional] 
 **multitenancy** | **bool** | Whether multitenancy is allowed. | [optional] 
 **policy_editor** | **bool** | Whether the editing of policies is allowed. | [optional] 

docs/Features.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**baseline** | **object** | If the template is `baseline-comparison` or `executive-overview` the baseline scan to compare against. This can be the `first` scan, the `previous` scan, or a scan as of a specified date. | [optional] 
+**baseline** | **object** | If the template is `baseline-comparison` or `executive-overview` the baseline scan to compare against. This can be the `first` scan, the `previous` scan, or a scan as of a specified date. Defaults to `previous`. | [optional] 
 **bureau** | **str** | The name of the bureau for a CyberScope report. Only used when the format is `\"cyberscope-xml\"`. | [optional] 
 **component** | **str** | The name of the component for a CyberScope report. Only used when the format is `\"cyberscope-xml\"`. | [optional] 
 **database** | [**ReportConfigDatabaseResource**](ReportConfigDatabaseResource.md) | Configuration for database export. Only used when the format is `\"database-export\"`. | [optional] 

docs/Report.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**location** | **str** | The location to storage an additional copy of the report. This is a sub-path post-fixed to `$(install_dir)/nsc/reports/$(user)/`. | [optional] 
+**location** | **str** | The location to storage an additional copy of the report. This is a sub-path post-fixed to `$(install_dir)/nsc/reports/$(user)/`. Variables such as `$(report_name)`, `$(date)`, and `$(time)` may be used to generate the directory structure.  | [optional] 
 **path** | **str** | The full path to the additional copy storage location. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ReportStorage.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **on_scan_repeat** | **str** | Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration. The following table describes each supported value:  | Value | Description |  | ---------- | ---------------- |  | restart-scan | Stops the previously-paused scan and launches a new scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. |  | resume-scan | Resumes the previously-paused scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. |   | 
 **repeat** | [**ReportRepeat**](ReportRepeat.md) | Settings for repeating a scheduled task. | [optional] 
 **scan_engine_id** | **int** | The identifier of the scan engine to be used for this scan schedule. If not set, the site's assigned scan engine will be used. | [optional] 
-**scan_name** | **str** | A user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Names must be unique. | [optional] 
+**scan_name** | **str** | A user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Scan names must be unique within the site's scan schedules. | [optional] 
 **scan_template_id** | **str** | The identifier of the scan template to be used for this scan schedule. If not set, the site's assigned scan template will be used. | [optional] 
 **start** | **str** | The scheduled start date and time. Date is represented in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time. | 
 

docs/ScanSchedule.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **authentication** | [**AuthenticationSettings**](AuthenticationSettings.md) | Details the authentication settings. | [optional] 
 **database** | [**DatabaseSettings**](DatabaseSettings.md) | Details the database settings. | [optional] 
 **directory** | **str** | The root directory of the console. | [optional] 
-**insight_platform** | **bool** | Whether the usage of the Insight Platform is enabled. | [optional] 
-**insight_platform_region** | **str** | The region used for the Insight Platform, if enabled. | [optional] 
+**insight_platform** | **bool** | Whether the usage of the Insight platform is enabled. | [optional] 
+**insight_platform_region** | **str** | The region used for the Insight platform, if enabled. | [optional] 
 **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 
 **risk** | [**RiskSettings**](RiskSettings.md) | Details risk configuration and settings. | [optional] 
 **scan** | [**ScanSettings**](ScanSettings.md) | Details the global settings for scanning. | [optional] 

docs/Settings.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **pem_key** | **str** |  | [optional] 
 **permission_elevation** | **str** |  | [optional] 
 **permission_elevation_password** | **str** |  | [optional] 
-**permission_elevation_user_name** | **str** |  | [optional] 
+**permission_elevation_username** | **str** |  | [optional] 
 **privacy_password** | **str** |  | [optional] 
 **privacy_type** | **str** |  | [optional] 
 **private_key_password** | **str** |  | [optional]