Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Commit 4bee83a

Browse files
authored
Merge pull request #2 from rapid7/release/6.5.10
release/6.5.10 - update to generated library based on 6.5.10 release …
2 parents 3e04e5a + 7e143cc commit 4bee83a

File tree

376 files changed

+3083
-1265
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

376 files changed

+3083
-1265
lines changed

api-files/console-swagger-6.5.10.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

docs/AdministrationApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ No authorization required
6363
[[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)
6464

6565
# **execute_command**
66-
> ConsoleCommandOutput execute_command(param0=param0)
66+
> ConsoleCommandOutput execute_command(command=command)
6767
6868
Console Commands
6969

@@ -79,11 +79,11 @@ from pprint import pprint
7979

8080
# create an instance of the API class
8181
api_instance = rapid7vmconsole.AdministrationApi()
82-
param0 = 'param0_example' # str | The console command to execute. (optional)
82+
command = 'command_example' # str | The console command to execute. (optional)
8383

8484
try:
8585
# Console Commands
86-
api_response = api_instance.execute_command(param0=param0)
86+
api_response = api_instance.execute_command(command=command)
8787
pprint(api_response)
8888
except ApiException as e:
8989
print("Exception when calling AdministrationApi->execute_command: %s\n" % e)
@@ -93,7 +93,7 @@ except ApiException as e:
9393

9494
Name | Type | Description | Notes
9595
------------- | ------------- | ------------- | -------------
96-
**param0** | **str**| The console command to execute. | [optional]
96+
**command** | **str**| The console command to execute. | [optional]
9797

9898
### Return type
9999

docs/AssetApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ No authorization required
8282
[[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)
8383

8484
# **create_asset**
85-
> CreatedReference create_asset(id, param1=param1)
85+
> CreatedReference create_asset(id, asset=asset)
8686
8787
Assets
8888

@@ -99,11 +99,11 @@ from pprint import pprint
9999
# create an instance of the API class
100100
api_instance = rapid7vmconsole.AssetApi()
101101
id = 56 # int | The identifier of the site.
102-
param1 = rapid7vmconsole.AssetCreate() # AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` (optional)
102+
asset = rapid7vmconsole.AssetCreate() # AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` (optional)
103103

104104
try:
105105
# Assets
106-
api_response = api_instance.create_asset(id, param1=param1)
106+
api_response = api_instance.create_asset(id, asset=asset)
107107
pprint(api_response)
108108
except ApiException as e:
109109
print("Exception when calling AssetApi->create_asset: %s\n" % e)
@@ -114,7 +114,7 @@ except ApiException as e:
114114
Name | Type | Description | Notes
115115
------------- | ------------- | ------------- | -------------
116116
**id** | **int**| The identifier of the site. |
117-
**param1** | [**AssetCreate**](AssetCreate.md)| The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` | [optional]
117+
**asset** | [**AssetCreate**](AssetCreate.md)| The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` | [optional]
118118

119119
### Return type
120120

docs/AssetDiscoveryApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Method | HTTP request | Description
1717

1818

1919
# **create_sonar_query**
20-
> CreatedReferenceDiscoveryQueryIDLink create_sonar_query(param0)
20+
> CreatedReferenceDiscoveryQueryIDLink create_sonar_query(query=query)
2121
2222
Sonar Queries
2323

@@ -33,11 +33,11 @@ from pprint import pprint
3333

3434
# create an instance of the API class
3535
api_instance = rapid7vmconsole.AssetDiscoveryApi()
36-
param0 = rapid7vmconsole.SonarQuery() # SonarQuery | param0
36+
query = rapid7vmconsole.SonarQuery() # SonarQuery | The criteria for a Sonar query. (optional)
3737

3838
try:
3939
# Sonar Queries
40-
api_response = api_instance.create_sonar_query(param0)
40+
api_response = api_instance.create_sonar_query(query=query)
4141
pprint(api_response)
4242
except ApiException as e:
4343
print("Exception when calling AssetDiscoveryApi->create_sonar_query: %s\n" % e)
@@ -47,7 +47,7 @@ except ApiException as e:
4747

4848
Name | Type | Description | Notes
4949
------------- | ------------- | ------------- | -------------
50-
**param0** | [**SonarQuery**](SonarQuery.md)| param0 |
50+
**query** | [**SonarQuery**](SonarQuery.md)| The criteria for a Sonar query. | [optional]
5151

5252
### Return type
5353

@@ -400,7 +400,7 @@ No authorization required
400400
[[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)
401401

402402
# **sonar_query_search**
403-
> list[DiscoveryAsset] sonar_query_search(param0)
403+
> list[DiscoveryAsset] sonar_query_search(query=query)
404404
405405
Sonar Query Search
406406

@@ -416,11 +416,11 @@ from pprint import pprint
416416

417417
# create an instance of the API class
418418
api_instance = rapid7vmconsole.AssetDiscoveryApi()
419-
param0 = rapid7vmconsole.SonarCriteria() # SonarCriteria | param0
419+
query = rapid7vmconsole.SonarCriteria() # SonarCriteria | The criteria for a Sonar query. (optional)
420420

421421
try:
422422
# Sonar Query Search
423-
api_response = api_instance.sonar_query_search(param0)
423+
api_response = api_instance.sonar_query_search(query=query)
424424
pprint(api_response)
425425
except ApiException as e:
426426
print("Exception when calling AssetDiscoveryApi->sonar_query_search: %s\n" % e)
@@ -430,7 +430,7 @@ except ApiException as e:
430430

431431
Name | Type | Description | Notes
432432
------------- | ------------- | ------------- | -------------
433-
**param0** | [**SonarCriteria**](SonarCriteria.md)| param0 |
433+
**query** | [**SonarCriteria**](SonarCriteria.md)| The criteria for a Sonar query. | [optional]
434434

435435
### Return type
436436

@@ -448,7 +448,7 @@ No authorization required
448448
[[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)
449449

450450
# **update_sonar_query**
451-
> Links update_sonar_query(id, param1)
451+
> Links update_sonar_query(id, query=query)
452452
453453
Sonar Query
454454

@@ -465,11 +465,11 @@ from pprint import pprint
465465
# create an instance of the API class
466466
api_instance = rapid7vmconsole.AssetDiscoveryApi()
467467
id = 789 # int | The identifier of the Sonar query.
468-
param1 = rapid7vmconsole.SonarQuery() # SonarQuery | param1
468+
query = rapid7vmconsole.SonarQuery() # SonarQuery | The criteria for a Sonar query. (optional)
469469

470470
try:
471471
# Sonar Query
472-
api_response = api_instance.update_sonar_query(id, param1)
472+
api_response = api_instance.update_sonar_query(id, query=query)
473473
pprint(api_response)
474474
except ApiException as e:
475475
print("Exception when calling AssetDiscoveryApi->update_sonar_query: %s\n" % e)
@@ -480,7 +480,7 @@ except ApiException as e:
480480
Name | Type | Description | Notes
481481
------------- | ------------- | ------------- | -------------
482482
**id** | **int**| The identifier of the Sonar query. |
483-
**param1** | [**SonarQuery**](SonarQuery.md)| param1 |
483+
**query** | [**SonarQuery**](SonarQuery.md)| The criteria for a Sonar query. | [optional]
484484

485485
### Return type
486486

docs/AssetGroupApi.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ No authorization required
178178
[[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)
179179

180180
# **create_asset_group**
181-
> CreatedReferenceAssetGroupIDLink create_asset_group(param0=param0)
181+
> CreatedReferenceAssetGroupIDLink create_asset_group(asset_group=asset_group)
182182
183183
Asset Groups
184184

@@ -194,11 +194,11 @@ from pprint import pprint
194194

195195
# create an instance of the API class
196196
api_instance = rapid7vmconsole.AssetGroupApi()
197-
param0 = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
197+
asset_group = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
198198

199199
try:
200200
# Asset Groups
201-
api_response = api_instance.create_asset_group(param0=param0)
201+
api_response = api_instance.create_asset_group(asset_group=asset_group)
202202
pprint(api_response)
203203
except ApiException as e:
204204
print("Exception when calling AssetGroupApi->create_asset_group: %s\n" % e)
@@ -208,7 +208,7 @@ except ApiException as e:
208208

209209
Name | Type | Description | Notes
210210
------------- | ------------- | ------------- | -------------
211-
**param0** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
211+
**asset_group** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
212212

213213
### Return type
214214

@@ -816,7 +816,7 @@ No authorization required
816816
[[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)
817817

818818
# **set_asset_group_search_criteria**
819-
> Links set_asset_group_search_criteria(id, param1=param1)
819+
> Links set_asset_group_search_criteria(id, criteria=criteria)
820820
821821
Asset Group Search Criteria
822822

@@ -833,11 +833,11 @@ from pprint import pprint
833833
# create an instance of the API class
834834
api_instance = rapid7vmconsole.AssetGroupApi()
835835
id = 56 # int | The identifier of the asset group.
836-
param1 = rapid7vmconsole.SearchCriteria() # SearchCriteria | The search criteria specification. (optional)
836+
criteria = rapid7vmconsole.SearchCriteria() # SearchCriteria | The search criteria specification. (optional)
837837

838838
try:
839839
# Asset Group Search Criteria
840-
api_response = api_instance.set_asset_group_search_criteria(id, param1=param1)
840+
api_response = api_instance.set_asset_group_search_criteria(id, criteria=criteria)
841841
pprint(api_response)
842842
except ApiException as e:
843843
print("Exception when calling AssetGroupApi->set_asset_group_search_criteria: %s\n" % e)
@@ -848,7 +848,7 @@ except ApiException as e:
848848
Name | Type | Description | Notes
849849
------------- | ------------- | ------------- | -------------
850850
**id** | **int**| The identifier of the asset group. |
851-
**param1** | [**SearchCriteria**](SearchCriteria.md)| The search criteria specification. | [optional]
851+
**criteria** | [**SearchCriteria**](SearchCriteria.md)| The search criteria specification. | [optional]
852852

853853
### Return type
854854

@@ -866,7 +866,7 @@ No authorization required
866866
[[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)
867867

868868
# **set_asset_group_tags**
869-
> Links set_asset_group_tags(id, param1=param1)
869+
> Links set_asset_group_tags(id, tags=tags)
870870
871871
Asset Group Tags
872872

@@ -883,11 +883,11 @@ from pprint import pprint
883883
# create an instance of the API class
884884
api_instance = rapid7vmconsole.AssetGroupApi()
885885
id = 56 # int | The identifier of the asset group.
886-
param1 = [rapid7vmconsole.list[int]()] # list[int] | The tags to associate to the asset group. (optional)
886+
tags = [rapid7vmconsole.list[int]()] # list[int] | The tags to associate to the asset group. (optional)
887887

888888
try:
889889
# Asset Group Tags
890-
api_response = api_instance.set_asset_group_tags(id, param1=param1)
890+
api_response = api_instance.set_asset_group_tags(id, tags=tags)
891891
pprint(api_response)
892892
except ApiException as e:
893893
print("Exception when calling AssetGroupApi->set_asset_group_tags: %s\n" % e)
@@ -898,7 +898,7 @@ except ApiException as e:
898898
Name | Type | Description | Notes
899899
------------- | ------------- | ------------- | -------------
900900
**id** | **int**| The identifier of the asset group. |
901-
**param1** | **list[int]**| The tags to associate to the asset group. | [optional]
901+
**tags** | **list[int]**| The tags to associate to the asset group. | [optional]
902902

903903
### Return type
904904

@@ -916,7 +916,7 @@ No authorization required
916916
[[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)
917917

918918
# **set_asset_group_users**
919-
> Links set_asset_group_users(id, param1=param1)
919+
> Links set_asset_group_users(id, users=users)
920920
921921
Asset Group Users
922922

@@ -933,11 +933,11 @@ from pprint import pprint
933933
# create an instance of the API class
934934
api_instance = rapid7vmconsole.AssetGroupApi()
935935
id = 56 # int | The identifier of the asset group.
936-
param1 = [rapid7vmconsole.list[int]()] # list[int] | The users to grant access to the asset group. (optional)
936+
users = [rapid7vmconsole.list[int]()] # list[int] | The users to grant access to the asset group. (optional)
937937

938938
try:
939939
# Asset Group Users
940-
api_response = api_instance.set_asset_group_users(id, param1=param1)
940+
api_response = api_instance.set_asset_group_users(id, users=users)
941941
pprint(api_response)
942942
except ApiException as e:
943943
print("Exception when calling AssetGroupApi->set_asset_group_users: %s\n" % e)
@@ -948,7 +948,7 @@ except ApiException as e:
948948
Name | Type | Description | Notes
949949
------------- | ------------- | ------------- | -------------
950950
**id** | **int**| The identifier of the asset group. |
951-
**param1** | **list[int]**| The users to grant access to the asset group. | [optional]
951+
**users** | **list[int]**| The users to grant access to the asset group. | [optional]
952952

953953
### Return type
954954

@@ -966,7 +966,7 @@ No authorization required
966966
[[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)
967967

968968
# **update_asset_group**
969-
> Links update_asset_group(id, param1=param1)
969+
> Links update_asset_group(id, asset_group=asset_group)
970970
971971
Asset Group
972972

@@ -983,11 +983,11 @@ from pprint import pprint
983983
# create an instance of the API class
984984
api_instance = rapid7vmconsole.AssetGroupApi()
985985
id = 56 # int | The identifier of the asset group.
986-
param1 = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
986+
asset_group = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
987987

988988
try:
989989
# Asset Group
990-
api_response = api_instance.update_asset_group(id, param1=param1)
990+
api_response = api_instance.update_asset_group(id, asset_group=asset_group)
991991
pprint(api_response)
992992
except ApiException as e:
993993
print("Exception when calling AssetGroupApi->update_asset_group: %s\n" % e)
@@ -998,7 +998,7 @@ except ApiException as e:
998998
Name | Type | Description | Notes
999999
------------- | ------------- | ------------- | -------------
10001000
**id** | **int**| The identifier of the asset group. |
1001-
**param1** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
1001+
**asset_group** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
10021002

10031003
### Return type
10041004

@@ -1016,7 +1016,7 @@ No authorization required
10161016
[[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)
10171017

10181018
# **update_asset_group_assets**
1019-
> Links update_asset_group_assets(id, param1=param1)
1019+
> Links update_asset_group_assets(id, assets=assets)
10201020
10211021
Asset Group Assets
10221022

@@ -1033,11 +1033,11 @@ from pprint import pprint
10331033
# create an instance of the API class
10341034
api_instance = rapid7vmconsole.AssetGroupApi()
10351035
id = 56 # int | The identifier of the asset group.
1036-
param1 = [rapid7vmconsole.list[int]()] # list[int] | The assets to place in the asset group. (optional)
1036+
assets = [rapid7vmconsole.list[int]()] # list[int] | The assets to place in the asset group. (optional)
10371037

10381038
try:
10391039
# Asset Group Assets
1040-
api_response = api_instance.update_asset_group_assets(id, param1=param1)
1040+
api_response = api_instance.update_asset_group_assets(id, assets=assets)
10411041
pprint(api_response)
10421042
except ApiException as e:
10431043
print("Exception when calling AssetGroupApi->update_asset_group_assets: %s\n" % e)
@@ -1048,7 +1048,7 @@ except ApiException as e:
10481048
Name | Type | Description | Notes
10491049
------------- | ------------- | ------------- | -------------
10501050
**id** | **int**| The identifier of the asset group. |
1051-
**param1** | **list[int]**| The assets to place in the asset group. | [optional]
1051+
**assets** | **list[int]**| The assets to place in the asset group. | [optional]
10521052

10531053
### Return type
10541054

docs/CreateAuthenticationSource.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**type** | **str** | The type of the authentication source to use to authenticate the user. Defaults to `normal`. | [optional]
6+
**id** | **int** | The identifier of the authentication source to use to authenticate the user. The source with the specified identifier must be of the type specified by `type`. If `id` is omitted, then one source of the specified `type` is selected. | [optional]
7+
**type** | **str** | The type of the authentication source to use to authenticate the user. |
78

89
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
910

0 commit comments

Comments
 (0)