Skip to content

Commit 8a32bf8

Browse files
committed
Autogenerated Update v2.56.8.
1 parent adab7a4 commit 8a32bf8

Some content is hidden

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

62 files changed

+5138
-524
lines changed

.swagger-codegen/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"gitUserId": "wavefrontHQ",
44
"packageName": "wavefront_api_client",
55
"packageUrl": "https://github.com/wavefrontHQ/python-client",
6-
"packageVersion": "2.55.18"
6+
"packageVersion": "2.56.8"
77
}

.swagger-codegen/config.jsone

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"gitUserId": "wavefrontHQ",
44
"packageName": "wavefront_api_client",
55
"packageUrl": "https://github.com/wavefrontHQ/python-client",
6-
"packageVersion": "2.55.15"
6+
"packageVersion": "2.55.18"
77
}

README.md

+34-3
Large diffs are not rendered by default.

docs/Account.md

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Name | Type | Description | Notes
66
**groups** | **list[str]** | The list of account's permissions. | [optional]
77
**identifier** | **str** | The unique identifier of an account. |
88
**ingestion_policy_id** | **str** | The identifier of the ingestion policy linked with account. | [optional]
9+
**roles** | **list[str]** | The list of account's roles. | [optional]
10+
**united_permissions** | **list[str]** | The list of account's permissions assigned directly or through united roles assigned to it | [optional]
11+
**united_roles** | **list[str]** | The list of account's roles assigned directly or through user groups assigned to it | [optional]
912
**user_groups** | **list[str]** | The list of account's user groups. | [optional]
1013

1114
[[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/AccountUserAndServiceAccountApi.md

+120-6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://YOUR_INSTANCE.wavefront.com*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**activate_account**](AccountUserAndServiceAccountApi.md#activate_account) | **POST** /api/v2/account/serviceaccount/{id}/activate | Activates the given service account
8+
[**add_account_to_roles**](AccountUserAndServiceAccountApi.md#add_account_to_roles) | **POST** /api/v2/account/{id}/addRoles | Adds specific roles to the account (user or service account)
89
[**add_account_to_user_groups**](AccountUserAndServiceAccountApi.md#add_account_to_user_groups) | **POST** /api/v2/account/{id}/addUserGroups | Adds specific user groups to the account (user or service account)
910
[**add_ingestion_policy**](AccountUserAndServiceAccountApi.md#add_ingestion_policy) | **POST** /api/v2/account/addingestionpolicy | Add a specific ingestion policy to multiple accounts
1011
[**create_or_update_user_account**](AccountUserAndServiceAccountApi.md#create_or_update_user_account) | **POST** /api/v2/account/user | Creates or updates a user account
@@ -22,6 +23,7 @@ Method | HTTP request | Description
2223
[**grant_account_permission**](AccountUserAndServiceAccountApi.md#grant_account_permission) | **POST** /api/v2/account/{id}/grant/{permission} | Grants a specific permission to account (user or service account)
2324
[**grant_permission_to_accounts**](AccountUserAndServiceAccountApi.md#grant_permission_to_accounts) | **POST** /api/v2/account/grant/{permission} | Grants a specific permission to multiple accounts (users or service accounts)
2425
[**invite_user_accounts**](AccountUserAndServiceAccountApi.md#invite_user_accounts) | **POST** /api/v2/account/user/invite | Invite user accounts with given user groups and permissions.
26+
[**remove_account_from_roles**](AccountUserAndServiceAccountApi.md#remove_account_from_roles) | **POST** /api/v2/account/{id}/removeRoles | Removes specific roles from the account (user or service account)
2527
[**remove_account_from_user_groups**](AccountUserAndServiceAccountApi.md#remove_account_from_user_groups) | **POST** /api/v2/account/{id}/removeUserGroups | Removes specific user groups from the account (user or service account)
2628
[**remove_ingestion_policies**](AccountUserAndServiceAccountApi.md#remove_ingestion_policies) | **POST** /api/v2/account/removeingestionpolicies | Removes ingestion policies from multiple accounts
2729
[**revoke_account_permission**](AccountUserAndServiceAccountApi.md#revoke_account_permission) | **POST** /api/v2/account/{id}/revoke/{permission} | Revokes a specific permission from account (user or service account)
@@ -85,6 +87,62 @@ Name | Type | Description | Notes
8587

8688
[[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)
8789

90+
# **add_account_to_roles**
91+
> UserModel add_account_to_roles(id, body=body)
92+
93+
Adds specific roles to the account (user or service account)
94+
95+
96+
97+
### Example
98+
```python
99+
from __future__ import print_function
100+
import time
101+
import wavefront_api_client
102+
from wavefront_api_client.rest import ApiException
103+
from pprint import pprint
104+
105+
# Configure API key authorization: api_key
106+
configuration = wavefront_api_client.Configuration()
107+
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
108+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
109+
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'
110+
111+
# create an instance of the API class
112+
api_instance = wavefront_api_client.AccountUserAndServiceAccountApi(wavefront_api_client.ApiClient(configuration))
113+
id = 'id_example' # str |
114+
body = [wavefront_api_client.list[str]()] # list[str] | The list of roles that should be added to the account (optional)
115+
116+
try:
117+
# Adds specific roles to the account (user or service account)
118+
api_response = api_instance.add_account_to_roles(id, body=body)
119+
pprint(api_response)
120+
except ApiException as e:
121+
print("Exception when calling AccountUserAndServiceAccountApi->add_account_to_roles: %s\n" % e)
122+
```
123+
124+
### Parameters
125+
126+
Name | Type | Description | Notes
127+
------------- | ------------- | ------------- | -------------
128+
**id** | **str**| |
129+
**body** | **list[str]**| The list of roles that should be added to the account | [optional]
130+
131+
### Return type
132+
133+
[**UserModel**](UserModel.md)
134+
135+
### Authorization
136+
137+
[api_key](../README.md#api_key)
138+
139+
### HTTP request headers
140+
141+
- **Content-Type**: application/json
142+
- **Accept**: application/json
143+
144+
[[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)
145+
88146
# **add_account_to_user_groups**
89147
> UserModel add_account_to_user_groups(id, body=body)
90148
@@ -219,7 +277,7 @@ configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
219277
# create an instance of the API class
220278
api_instance = wavefront_api_client.AccountUserAndServiceAccountApi(wavefront_api_client.ApiClient(configuration))
221279
send_email = true # bool | Whether to send email notification to the user, if created. Default: false (optional)
222-
body = wavefront_api_client.UserToCreate() # UserToCreate | Example Body: <pre>{ \"emailAddress\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\" }</pre> (optional)
280+
body = wavefront_api_client.UserToCreate() # UserToCreate | Example Body: <pre>{ \"emailAddress\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\", \"roles\": [ \"Role\" ] }</pre> (optional)
223281

224282
try:
225283
# Creates or updates a user account
@@ -234,7 +292,7 @@ except ApiException as e:
234292
Name | Type | Description | Notes
235293
------------- | ------------- | ------------- | -------------
236294
**send_email** | **bool**| Whether to send email notification to the user, if created. Default: false | [optional]
237-
**body** | [**UserToCreate**](UserToCreate.md)| Example Body: &lt;pre&gt;{ \&quot;emailAddress\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot; }&lt;/pre&gt; | [optional]
295+
**body** | [**UserToCreate**](UserToCreate.md)| Example Body: &lt;pre&gt;{ \&quot;emailAddress\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot;, \&quot;roles\&quot;: [ \&quot;Role\&quot; ] }&lt;/pre&gt; | [optional]
238296

239297
### Return type
240298

@@ -974,7 +1032,7 @@ configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
9741032

9751033
# create an instance of the API class
9761034
api_instance = wavefront_api_client.AccountUserAndServiceAccountApi(wavefront_api_client.ApiClient(configuration))
977-
body = [wavefront_api_client.UserToCreate()] # list[UserToCreate] | Example Body: <pre>[ { \"emailAddress\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\" } ]</pre> (optional)
1035+
body = [wavefront_api_client.UserToCreate()] # list[UserToCreate] | Example Body: <pre>[ { \"emailAddress\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\", \"roles\": [ \"Role\" ] } ]</pre> (optional)
9781036

9791037
try:
9801038
# Invite user accounts with given user groups and permissions.
@@ -988,7 +1046,63 @@ except ApiException as e:
9881046

9891047
Name | Type | Description | Notes
9901048
------------- | ------------- | ------------- | -------------
991-
**body** | [**list[UserToCreate]**](UserToCreate.md)| Example Body: &lt;pre&gt;[ { \&quot;emailAddress\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot; } ]&lt;/pre&gt; | [optional]
1049+
**body** | [**list[UserToCreate]**](UserToCreate.md)| Example Body: &lt;pre&gt;[ { \&quot;emailAddress\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot;, \&quot;roles\&quot;: [ \&quot;Role\&quot; ] } ]&lt;/pre&gt; | [optional]
1050+
1051+
### Return type
1052+
1053+
[**UserModel**](UserModel.md)
1054+
1055+
### Authorization
1056+
1057+
[api_key](../README.md#api_key)
1058+
1059+
### HTTP request headers
1060+
1061+
- **Content-Type**: application/json
1062+
- **Accept**: application/json
1063+
1064+
[[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)
1065+
1066+
# **remove_account_from_roles**
1067+
> UserModel remove_account_from_roles(id, body=body)
1068+
1069+
Removes specific roles from the account (user or service account)
1070+
1071+
1072+
1073+
### Example
1074+
```python
1075+
from __future__ import print_function
1076+
import time
1077+
import wavefront_api_client
1078+
from wavefront_api_client.rest import ApiException
1079+
from pprint import pprint
1080+
1081+
# Configure API key authorization: api_key
1082+
configuration = wavefront_api_client.Configuration()
1083+
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
1084+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1085+
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'
1086+
1087+
# create an instance of the API class
1088+
api_instance = wavefront_api_client.AccountUserAndServiceAccountApi(wavefront_api_client.ApiClient(configuration))
1089+
id = 'id_example' # str |
1090+
body = [wavefront_api_client.list[str]()] # list[str] | The list of roles that should be removed from the account (optional)
1091+
1092+
try:
1093+
# Removes specific roles from the account (user or service account)
1094+
api_response = api_instance.remove_account_from_roles(id, body=body)
1095+
pprint(api_response)
1096+
except ApiException as e:
1097+
print("Exception when calling AccountUserAndServiceAccountApi->remove_account_from_roles: %s\n" % e)
1098+
```
1099+
1100+
### Parameters
1101+
1102+
Name | Type | Description | Notes
1103+
------------- | ------------- | ------------- | -------------
1104+
**id** | **str**| |
1105+
**body** | **list[str]**| The list of roles that should be removed from the account | [optional]
9921106

9931107
### Return type
9941108

@@ -1307,7 +1421,7 @@ configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
13071421
# create an instance of the API class
13081422
api_instance = wavefront_api_client.AccountUserAndServiceAccountApi(wavefront_api_client.ApiClient(configuration))
13091423
id = 'id_example' # str |
1310-
body = wavefront_api_client.UserRequestDTO() # UserRequestDTO | Example Body: <pre>{ \"identifier\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\" }</pre> (optional)
1424+
body = wavefront_api_client.UserRequestDTO() # UserRequestDTO | Example Body: <pre>{ \"identifier\": \"[email protected]\", \"groups\": [ \"user_management\" ], \"userGroups\": [ \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\" ], \"ingestionPolicyId\": \"ingestionPolicyId\", \"roles\": [ \"Role\" ] }</pre> (optional)
13111425

13121426
try:
13131427
# Update user with given user groups, permissions and ingestion policy.
@@ -1322,7 +1436,7 @@ except ApiException as e:
13221436
Name | Type | Description | Notes
13231437
------------- | ------------- | ------------- | -------------
13241438
**id** | **str**| |
1325-
**body** | [**UserRequestDTO**](UserRequestDTO.md)| Example Body: &lt;pre&gt;{ \&quot;identifier\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot; }&lt;/pre&gt; | [optional]
1439+
**body** | [**UserRequestDTO**](UserRequestDTO.md)| Example Body: &lt;pre&gt;{ \&quot;identifier\&quot;: \&quot;[email protected]\&quot;, \&quot;groups\&quot;: [ \&quot;user_management\&quot; ], \&quot;userGroups\&quot;: [ \&quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090\&quot; ], \&quot;ingestionPolicyId\&quot;: \&quot;ingestionPolicyId\&quot;, \&quot;roles\&quot;: [ \&quot;Role\&quot; ] }&lt;/pre&gt; | [optional]
13261440

13271441
### Return type
13281442

docs/CustomerFacingUserObject.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
1212
**ingestion_policy_id** | **str** | The identifier of the ingestion policy linked with user. | [optional]
1313
**last_successful_login** | **int** | The last time the user logged in, in epoch milliseconds | [optional]
1414
**_self** | **bool** | Whether this user is the one calling the API |
15+
**united_permissions** | **list[str]** | The list of account&#39;s permissions assigned directly or through united roles assigned to it | [optional]
16+
**united_roles** | **list[str]** | The list of account&#39;s roles assigned directly or through user groups assigned to it | [optional]
1517
**user_groups** | **list[str]** | List of user group identifiers this user belongs to | [optional]
1618

1719
[[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/Event.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**alert_tags** | **list[str]** | The list of tags on the alert which created this event. | [optional]
67
**annotations** | **dict(str, str)** | A string-&gt;string map of additional annotations on the event |
78
**can_close** | **bool** | | [optional]
89
**can_delete** | **bool** | | [optional]

docs/PagedRoleDTO.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# PagedRoleDTO
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**cursor** | **str** | The id at which the current (limited) search can be continued to obtain more matching items | [optional]
7+
**items** | [**list[RoleDTO]**](RoleDTO.md) | List of requested items | [optional]
8+
**limit** | **int** | | [optional]
9+
**more_items** | **bool** | Whether more items are available for return by increment offset or cursor | [optional]
10+
**offset** | **int** | | [optional]
11+
**sort** | [**Sorting**](Sorting.md) | | [optional]
12+
**total_items** | **int** | An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

docs/RelatedEvent.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**alert_tags** | **list[str]** | The list of tags on the alert which created this event. | [optional]
67
**annotations** | **dict(str, str)** | A string-&gt;string map of additional annotations on the event |
78
**can_close** | **bool** | | [optional]
89
**can_delete** | **bool** | | [optional]

docs/ResponseContainerPagedRoleDTO.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ResponseContainerPagedRoleDTO
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**response** | [**PagedRoleDTO**](PagedRoleDTO.md) | | [optional]
7+
**status** | [**ResponseStatus**](ResponseStatus.md) | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/ResponseContainerRoleDTO.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ResponseContainerRoleDTO
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**response** | [**RoleDTO**](RoleDTO.md) | | [optional]
7+
**status** | [**ResponseStatus**](ResponseStatus.md) | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)