|
| 1 | +# wavefront_api_client.AccountServiceAccountApi |
| 2 | + |
| 3 | +All URIs are relative to *https://YOUR_INSTANCE.wavefront.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**activate_account**](AccountServiceAccountApi.md#activate_account) | **POST** /api/v2/account/serviceaccount/{id}/activate | Activates the given service account |
| 8 | +[**create_service_account**](AccountServiceAccountApi.md#create_service_account) | **POST** /api/v2/account/serviceaccount | Creates a service account |
| 9 | +[**deactivate_account**](AccountServiceAccountApi.md#deactivate_account) | **POST** /api/v2/account/serviceaccount/{id}/deactivate | Deactivates the given service account |
| 10 | +[**get_all_service_accounts**](AccountServiceAccountApi.md#get_all_service_accounts) | **GET** /api/v2/account/serviceaccount | Get all service accounts |
| 11 | +[**get_service_account**](AccountServiceAccountApi.md#get_service_account) | **GET** /api/v2/account/serviceaccount/{id} | Retrieves a service account by identifier |
| 12 | +[**update_service_account**](AccountServiceAccountApi.md#update_service_account) | **PUT** /api/v2/account/serviceaccount/{id} | Updates the service account |
| 13 | + |
| 14 | + |
| 15 | +# **activate_account** |
| 16 | +> ResponseContainerServiceAccount activate_account(id) |
| 17 | +
|
| 18 | +Activates the given service account |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +### Example |
| 23 | +```python |
| 24 | +from __future__ import print_function |
| 25 | +import time |
| 26 | +import wavefront_api_client |
| 27 | +from wavefront_api_client.rest import ApiException |
| 28 | +from pprint import pprint |
| 29 | + |
| 30 | +# Configure API key authorization: api_key |
| 31 | +configuration = wavefront_api_client.Configuration() |
| 32 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 33 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 34 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 35 | + |
| 36 | +# create an instance of the API class |
| 37 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 38 | +id = 'id_example' # str | |
| 39 | + |
| 40 | +try: |
| 41 | + # Activates the given service account |
| 42 | + api_response = api_instance.activate_account(id) |
| 43 | + pprint(api_response) |
| 44 | +except ApiException as e: |
| 45 | + print("Exception when calling AccountServiceAccountApi->activate_account: %s\n" % e) |
| 46 | +``` |
| 47 | + |
| 48 | +### Parameters |
| 49 | + |
| 50 | +Name | Type | Description | Notes |
| 51 | +------------- | ------------- | ------------- | ------------- |
| 52 | + **id** | **str**| | |
| 53 | + |
| 54 | +### Return type |
| 55 | + |
| 56 | +[**ResponseContainerServiceAccount**](ResponseContainerServiceAccount.md) |
| 57 | + |
| 58 | +### Authorization |
| 59 | + |
| 60 | +[api_key](../README.md#api_key) |
| 61 | + |
| 62 | +### HTTP request headers |
| 63 | + |
| 64 | + - **Content-Type**: application/json |
| 65 | + - **Accept**: application/json |
| 66 | + |
| 67 | +[[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) |
| 68 | + |
| 69 | +# **create_service_account** |
| 70 | +> ResponseContainerServiceAccount create_service_account(body=body) |
| 71 | +
|
| 72 | +Creates a service account |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +### Example |
| 77 | +```python |
| 78 | +from __future__ import print_function |
| 79 | +import time |
| 80 | +import wavefront_api_client |
| 81 | +from wavefront_api_client.rest import ApiException |
| 82 | +from pprint import pprint |
| 83 | + |
| 84 | +# Configure API key authorization: api_key |
| 85 | +configuration = wavefront_api_client.Configuration() |
| 86 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 87 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 88 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 89 | + |
| 90 | +# create an instance of the API class |
| 91 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 92 | +body = wavefront_api_client.ServiceAccountWrite() # ServiceAccountWrite | (optional) |
| 93 | + |
| 94 | +try: |
| 95 | + # Creates a service account |
| 96 | + api_response = api_instance.create_service_account(body=body) |
| 97 | + pprint(api_response) |
| 98 | +except ApiException as e: |
| 99 | + print("Exception when calling AccountServiceAccountApi->create_service_account: %s\n" % e) |
| 100 | +``` |
| 101 | + |
| 102 | +### Parameters |
| 103 | + |
| 104 | +Name | Type | Description | Notes |
| 105 | +------------- | ------------- | ------------- | ------------- |
| 106 | + **body** | [**ServiceAccountWrite**](ServiceAccountWrite.md)| | [optional] |
| 107 | + |
| 108 | +### Return type |
| 109 | + |
| 110 | +[**ResponseContainerServiceAccount**](ResponseContainerServiceAccount.md) |
| 111 | + |
| 112 | +### Authorization |
| 113 | + |
| 114 | +[api_key](../README.md#api_key) |
| 115 | + |
| 116 | +### HTTP request headers |
| 117 | + |
| 118 | + - **Content-Type**: application/json |
| 119 | + - **Accept**: application/json |
| 120 | + |
| 121 | +[[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) |
| 122 | + |
| 123 | +# **deactivate_account** |
| 124 | +> ResponseContainerServiceAccount deactivate_account(id) |
| 125 | +
|
| 126 | +Deactivates the given service account |
| 127 | + |
| 128 | + |
| 129 | + |
| 130 | +### Example |
| 131 | +```python |
| 132 | +from __future__ import print_function |
| 133 | +import time |
| 134 | +import wavefront_api_client |
| 135 | +from wavefront_api_client.rest import ApiException |
| 136 | +from pprint import pprint |
| 137 | + |
| 138 | +# Configure API key authorization: api_key |
| 139 | +configuration = wavefront_api_client.Configuration() |
| 140 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 141 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 142 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 143 | + |
| 144 | +# create an instance of the API class |
| 145 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 146 | +id = 'id_example' # str | |
| 147 | + |
| 148 | +try: |
| 149 | + # Deactivates the given service account |
| 150 | + api_response = api_instance.deactivate_account(id) |
| 151 | + pprint(api_response) |
| 152 | +except ApiException as e: |
| 153 | + print("Exception when calling AccountServiceAccountApi->deactivate_account: %s\n" % e) |
| 154 | +``` |
| 155 | + |
| 156 | +### Parameters |
| 157 | + |
| 158 | +Name | Type | Description | Notes |
| 159 | +------------- | ------------- | ------------- | ------------- |
| 160 | + **id** | **str**| | |
| 161 | + |
| 162 | +### Return type |
| 163 | + |
| 164 | +[**ResponseContainerServiceAccount**](ResponseContainerServiceAccount.md) |
| 165 | + |
| 166 | +### Authorization |
| 167 | + |
| 168 | +[api_key](../README.md#api_key) |
| 169 | + |
| 170 | +### HTTP request headers |
| 171 | + |
| 172 | + - **Content-Type**: application/json |
| 173 | + - **Accept**: application/json |
| 174 | + |
| 175 | +[[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) |
| 176 | + |
| 177 | +# **get_all_service_accounts** |
| 178 | +> ResponseContainerListServiceAccount get_all_service_accounts() |
| 179 | +
|
| 180 | +Get all service accounts |
| 181 | + |
| 182 | + |
| 183 | + |
| 184 | +### Example |
| 185 | +```python |
| 186 | +from __future__ import print_function |
| 187 | +import time |
| 188 | +import wavefront_api_client |
| 189 | +from wavefront_api_client.rest import ApiException |
| 190 | +from pprint import pprint |
| 191 | + |
| 192 | +# Configure API key authorization: api_key |
| 193 | +configuration = wavefront_api_client.Configuration() |
| 194 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 195 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 196 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 197 | + |
| 198 | +# create an instance of the API class |
| 199 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 200 | + |
| 201 | +try: |
| 202 | + # Get all service accounts |
| 203 | + api_response = api_instance.get_all_service_accounts() |
| 204 | + pprint(api_response) |
| 205 | +except ApiException as e: |
| 206 | + print("Exception when calling AccountServiceAccountApi->get_all_service_accounts: %s\n" % e) |
| 207 | +``` |
| 208 | + |
| 209 | +### Parameters |
| 210 | +This endpoint does not need any parameter. |
| 211 | + |
| 212 | +### Return type |
| 213 | + |
| 214 | +[**ResponseContainerListServiceAccount**](ResponseContainerListServiceAccount.md) |
| 215 | + |
| 216 | +### Authorization |
| 217 | + |
| 218 | +[api_key](../README.md#api_key) |
| 219 | + |
| 220 | +### HTTP request headers |
| 221 | + |
| 222 | + - **Content-Type**: Not defined |
| 223 | + - **Accept**: application/json |
| 224 | + |
| 225 | +[[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) |
| 226 | + |
| 227 | +# **get_service_account** |
| 228 | +> ResponseContainerServiceAccount get_service_account(id) |
| 229 | +
|
| 230 | +Retrieves a service account by identifier |
| 231 | + |
| 232 | + |
| 233 | + |
| 234 | +### Example |
| 235 | +```python |
| 236 | +from __future__ import print_function |
| 237 | +import time |
| 238 | +import wavefront_api_client |
| 239 | +from wavefront_api_client.rest import ApiException |
| 240 | +from pprint import pprint |
| 241 | + |
| 242 | +# Configure API key authorization: api_key |
| 243 | +configuration = wavefront_api_client.Configuration() |
| 244 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 245 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 246 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 247 | + |
| 248 | +# create an instance of the API class |
| 249 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 250 | +id = 'id_example' # str | |
| 251 | + |
| 252 | +try: |
| 253 | + # Retrieves a service account by identifier |
| 254 | + api_response = api_instance.get_service_account(id) |
| 255 | + pprint(api_response) |
| 256 | +except ApiException as e: |
| 257 | + print("Exception when calling AccountServiceAccountApi->get_service_account: %s\n" % e) |
| 258 | +``` |
| 259 | + |
| 260 | +### Parameters |
| 261 | + |
| 262 | +Name | Type | Description | Notes |
| 263 | +------------- | ------------- | ------------- | ------------- |
| 264 | + **id** | **str**| | |
| 265 | + |
| 266 | +### Return type |
| 267 | + |
| 268 | +[**ResponseContainerServiceAccount**](ResponseContainerServiceAccount.md) |
| 269 | + |
| 270 | +### Authorization |
| 271 | + |
| 272 | +[api_key](../README.md#api_key) |
| 273 | + |
| 274 | +### HTTP request headers |
| 275 | + |
| 276 | + - **Content-Type**: Not defined |
| 277 | + - **Accept**: application/json |
| 278 | + |
| 279 | +[[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) |
| 280 | + |
| 281 | +# **update_service_account** |
| 282 | +> ResponseContainerServiceAccount update_service_account(id, body=body) |
| 283 | +
|
| 284 | +Updates the service account |
| 285 | + |
| 286 | + |
| 287 | + |
| 288 | +### Example |
| 289 | +```python |
| 290 | +from __future__ import print_function |
| 291 | +import time |
| 292 | +import wavefront_api_client |
| 293 | +from wavefront_api_client.rest import ApiException |
| 294 | +from pprint import pprint |
| 295 | + |
| 296 | +# Configure API key authorization: api_key |
| 297 | +configuration = wavefront_api_client.Configuration() |
| 298 | +configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY' |
| 299 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 300 | +# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer' |
| 301 | + |
| 302 | +# create an instance of the API class |
| 303 | +api_instance = wavefront_api_client.AccountServiceAccountApi(wavefront_api_client.ApiClient(configuration)) |
| 304 | +id = 'id_example' # str | |
| 305 | +body = wavefront_api_client.ServiceAccountWrite() # ServiceAccountWrite | (optional) |
| 306 | + |
| 307 | +try: |
| 308 | + # Updates the service account |
| 309 | + api_response = api_instance.update_service_account(id, body=body) |
| 310 | + pprint(api_response) |
| 311 | +except ApiException as e: |
| 312 | + print("Exception when calling AccountServiceAccountApi->update_service_account: %s\n" % e) |
| 313 | +``` |
| 314 | + |
| 315 | +### Parameters |
| 316 | + |
| 317 | +Name | Type | Description | Notes |
| 318 | +------------- | ------------- | ------------- | ------------- |
| 319 | + **id** | **str**| | |
| 320 | + **body** | [**ServiceAccountWrite**](ServiceAccountWrite.md)| | [optional] |
| 321 | + |
| 322 | +### Return type |
| 323 | + |
| 324 | +[**ResponseContainerServiceAccount**](ResponseContainerServiceAccount.md) |
| 325 | + |
| 326 | +### Authorization |
| 327 | + |
| 328 | +[api_key](../README.md#api_key) |
| 329 | + |
| 330 | +### HTTP request headers |
| 331 | + |
| 332 | + - **Content-Type**: application/json |
| 333 | + - **Accept**: application/json |
| 334 | + |
| 335 | +[[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) |
| 336 | + |
0 commit comments