Merge pull request #4 from rapid7/release/6.5.19

release/6.5.19 - changes based on console version 6.5.19
rapid7 · May 22, 2018 · 4a46df8 · 4a46df8
2 parents 4bee83a + 18aa605
commit 4a46df8
Show file tree

Hide file tree

Showing 28 changed files with 207 additions and 59 deletions.
diff --git a/api-files/console-swagger-6.5.19.json b/api-files/console-swagger-6.5.19.json
diff --git a/docs/ExceptionScope.md b/docs/ExceptionScope.md
@@ -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 &#x60;\&quot;Instance\&quot;&#x60;, 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 &#x60;\&quot;Instance\&quot;&#x60; and the vulnerability is detected on a service, the port on which the exception applies. | [optional] 

diff --git a/docs/Features.md b/docs/Features.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] 

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

diff --git a/docs/ReportStorage.md b/docs/ReportStorage.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 &#x60;$(install_dir)/nsc/reports/$(user)/&#x60;. | [optional] 
+**location** | **str** | The location to storage an additional copy of the report. This is a sub-path post-fixed to &#x60;$(install_dir)/nsc/reports/$(user)/&#x60;. Variables such as &#x60;$(report_name)&#x60;, &#x60;$(date)&#x60;, and &#x60;$(time)&#x60; 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)

diff --git a/docs/ScanSchedule.md b/docs/ScanSchedule.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&#39;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&#39;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&#39;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. | 
 

diff --git a/docs/Settings.md b/docs/Settings.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] 

diff --git a/docs/SharedCredential.md b/docs/SharedCredential.md
diff --git a/docs/SharedCredentialAccount.md b/docs/SharedCredentialAccount.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] 

diff --git a/docs/SiteCredential.md b/docs/SiteCredential.md
diff --git a/docs/UserApi.md b/docs/UserApi.md
@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**add_user_site**](UserApi.md#add_user_site) | **PUT** /api/3/users/{id}/sites/{siteId} | Site Access
 [**create_user**](UserApi.md#create_user) | **POST** /api/3/users | Users
 [**delete_role**](UserApi.md#delete_role) | **DELETE** /api/3/roles/{id} | Role
+[**delete_user**](UserApi.md#delete_user) | **DELETE** /api/3/users/{id} | User
 [**get_authentication_source**](UserApi.md#get_authentication_source) | **GET** /api/3/authentication_sources/{id} | Authentication Source
 [**get_authentication_source_users**](UserApi.md#get_authentication_source_users) | **GET** /api/3/authentication_sources/{id}/users | Authentication Source Users
 [**get_authentication_sources**](UserApi.md#get_authentication_sources) | **GET** /api/3/authentication_sources | Authentication Sources
@@ -233,6 +234,54 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **delete_user**
+> Links delete_user(id)
+
+User
+
+Deletes a user account.<span class=\"authorization\">Global Administrator</span>
+
+### Example
+```python
+from __future__ import print_function
+import time
+import rapid7vmconsole
+from rapid7vmconsole.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = rapid7vmconsole.UserApi()
+id = 56 # int | The identifier of the user.
+
+try:
+    # User
+    api_response = api_instance.delete_user(id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling UserApi->delete_user: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| The identifier of the user. | 
+
+### Return type
+
+[**Links**](Links.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **get_authentication_source**
 > AuthenticationSource get_authentication_source(id)
 

diff --git a/git_push.sh b/git_push.sh
@@ -18,7 +18,7 @@ if [ "$git_repo_id" = "" ]; then
 fi
 
 if [ "$release_note" = "" ]; then
-    release_note="Update generated library to version: 6.5.10"
+    release_note="Update generated library to version: 0.0.1-6.5.19"
     echo "[INFO] No command line input provided. Set \$release_note to $release_note"
 fi
 

diff --git a/rapid7vmconsole/api/user_api.py b/rapid7vmconsole/api/user_api.py
@@ -441,6 +441,105 @@ def delete_role_with_http_info(self, id, **kwargs):  # noqa: E501
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def delete_user(self, id, **kwargs):  # noqa: E501
+        """User  # noqa: E501
+
+        Deletes a user account.<span class=\"authorization\">Global Administrator</span>  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async=True
+        >>> thread = api.delete_user(id, async=True)
+        >>> result = thread.get()
+
+        :param async bool
+        :param int id: The identifier of the user. (required)
+        :return: Links
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async'):
+            return self.delete_user_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_user_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def delete_user_with_http_info(self, id, **kwargs):  # noqa: E501
+        """User  # noqa: E501
+
+        Deletes a user account.<span class=\"authorization\">Global Administrator</span>  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async=True
+        >>> thread = api.delete_user_with_http_info(id, async=True)
+        >>> result = thread.get()
+
+        :param async bool
+        :param int id: The identifier of the user. (required)
+        :return: Links
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['id']  # noqa: E501
+        all_params.append('async')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method delete_user" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'id' is set
+        if ('id' not in params or
+                params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `delete_user`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json;charset=UTF-8'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/api/3/users/{id}', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Links',  # noqa: E501
+            auth_settings=auth_settings,
+            async=params.get('async'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def get_authentication_source(self, id, **kwargs):  # noqa: E501
         """Authentication Source  # noqa: E501
 

diff --git a/rapid7vmconsole/api_client.py b/rapid7vmconsole/api_client.py
@@ -73,7 +73,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/0.0.1-6.5.10/python'
+        self.user_agent = 'Swagger-Codegen/0.0.1-6.5.19/python'
 
     def __del__(self):
         self.pool.close()

diff --git a/rapid7vmconsole/configuration.py b/rapid7vmconsole/configuration.py
@@ -243,5 +243,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 3\n"\
-               "SDK Package Version: 0.0.1-6.5.10".\
+               "SDK Package Version: 0.0.1-6.5.19".\
                format(env=sys.platform, pyversion=sys.version)
diff --git a/rapid7vmconsole/models/authentication_source.py b/rapid7vmconsole/models/authentication_source.py
@@ -181,7 +181,7 @@ def type(self, type):
         :param type: The type of this AuthenticationSource.  # noqa: E501
         :type: str
         """
-        allowed_values = ["normal", "kerberos", "ldap", "admin"]  # noqa: E501
+        allowed_values = ["normal", "kerberos", "ldap", "saml", "admin"]  # noqa: E501
         if type not in allowed_values:
             raise ValueError(
                 "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501

diff --git a/rapid7vmconsole/models/exception_scope.py b/rapid7vmconsole/models/exception_scope.py
@@ -78,7 +78,7 @@ def __init__(self, id=None, key=None, links=None, port=None, type=None, vulnerab
     def id(self):
         """Gets the id of this ExceptionScope.  # noqa: E501
 
-        The identifier of the vulnerability to which the exception applies.  # noqa: E501
+        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.  # noqa: E501
 
         :return: The id of this ExceptionScope.  # noqa: E501
         :rtype: int
@@ -89,7 +89,7 @@ def id(self):
     def id(self, id):
         """Sets the id of this ExceptionScope.
 
-        The identifier of the vulnerability to which the exception applies.  # noqa: E501
+        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.  # noqa: E501
 
         :param id: The id of this ExceptionScope.  # noqa: E501
         :type: int

diff --git a/rapid7vmconsole/models/features.py b/rapid7vmconsole/models/features.py
@@ -229,7 +229,7 @@ def engine_pool(self, engine_pool):
     def insight_platform(self):
         """Gets the insight_platform of this Features.  # noqa: E501
 
-        Whether the usage of the Insight Platform is allowed.  # noqa: E501
+        Whether the usage of the Insight platform is allowed.  # noqa: E501
 
         :return: The insight_platform of this Features.  # noqa: E501
         :rtype: bool
@@ -240,7 +240,7 @@ def insight_platform(self):
     def insight_platform(self, insight_platform):
         """Sets the insight_platform of this Features.
 
-        Whether the usage of the Insight Platform is allowed.  # noqa: E501
+        Whether the usage of the Insight platform is allowed.  # noqa: E501
 
         :param insight_platform: The insight_platform of this Features.  # noqa: E501
         :type: bool

diff --git a/rapid7vmconsole/models/report.py b/rapid7vmconsole/models/report.py
@@ -192,7 +192,7 @@ def __init__(self, baseline=None, bureau=None, component=None, database=None, em
     def baseline(self):
         """Gets the baseline of this Report.  # noqa: E501
 
-        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.  # noqa: E501
+        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`.  # noqa: E501
 
         :return: The baseline of this Report.  # noqa: E501
         :rtype: object
@@ -203,7 +203,7 @@ def baseline(self):
     def baseline(self, baseline):
         """Sets the baseline of this Report.
 
-        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.  # noqa: E501
+        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`.  # noqa: E501
 
         :param baseline: The baseline of this Report.  # noqa: E501
         :type: object

diff --git a/rapid7vmconsole/models/report_storage.py b/rapid7vmconsole/models/report_storage.py
@@ -56,7 +56,7 @@ def __init__(self, location=None, path=None):  # noqa: E501
     def location(self):
         """Gets the location of this ReportStorage.  # noqa: E501
 
-        The location to storage an additional copy of the report. This is a sub-path post-fixed to `$(install_dir)/nsc/reports/$(user)/`.  # noqa: E501
+        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.   # noqa: E501
 
         :return: The location of this ReportStorage.  # noqa: E501
         :rtype: str
@@ -67,7 +67,7 @@ def location(self):
     def location(self, location):
         """Sets the location of this ReportStorage.
 
-        The location to storage an additional copy of the report. This is a sub-path post-fixed to `$(install_dir)/nsc/reports/$(user)/`.  # noqa: E501
+        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.   # noqa: E501
 
         :param location: The location of this ReportStorage.  # noqa: E501
         :type: str