Merge branch 'main' into CP-2386-2

This commit is contained in:
João Malés 2024-09-27 14:31:52 +01:00 committed by GitHub
commit 53d5efb385
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1869 changed files with 33053 additions and 24448 deletions

View File

@ -3,7 +3,7 @@ name: Python CI
on: on:
push: push:
branches: [ "main" ] branches: [ "main" ]
pull_request: pull_request_target:
branches: [ "main" ] branches: [ "main" ]
jobs: jobs:
@ -23,7 +23,27 @@ jobs:
- name: Install and test modules - name: Install and test modules
run: | run: |
pip install pytest pip install pytest
for module in $(find . -maxdepth 1 -type d -name "thousandeyes-sdk-*" | cut -c 3-); do pip install coverage
# Initialize coverage data file
coverage erase
for module in $(find . -maxdepth 1 -type d -name "thousandeyes-sdk-*" | cut -c 3-); do
pip install -e $module pip install -e $module
pytest $module coverage run --source=$module -m pytest $module
# Move the .coverage file to a unique name
mv .coverage .coverage.$module
done done
# Combine all .coverage files
coverage combine .coverage.*
coverage report
coverage xml
- name: Get Coverage
uses: orgoro/coverage@v3.2
with:
coverageFile: ./coverage.xml
thresholdAll: 0.4
thresholdNew: 0.6
token: ${{ secrets.GITHUB_TOKEN }}

View File

@ -7,7 +7,7 @@ on:
jobs: jobs:
set-package-matrix: set-package-matrix:
# This action returns all sub-packages to be published. # This action returns all sub-packages to be published.
# It thens exports the variable to matrix, so that the deployment job is run individually for each sub-package # It thens exports the variable to `matrix`, so that the deployment job is run individually for each sub-package
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
packages: ${{ steps.packages.outputs.packages }} packages: ${{ steps.packages.outputs.packages }}
@ -18,7 +18,6 @@ jobs:
FOLDERS_JSON=$(find . -maxdepth 1 -type d -name "thousandeyes-sdk-*" | cut -c 3- | jq -R -s -c 'split("\n")[:-1]') FOLDERS_JSON=$(find . -maxdepth 1 -type d -name "thousandeyes-sdk-*" | cut -c 3- | jq -R -s -c 'split("\n")[:-1]')
echo "packages=$FOLDERS_JSON" >> "$GITHUB_OUTPUT" echo "packages=$FOLDERS_JSON" >> "$GITHUB_OUTPUT"
deployment: deployment:
if: github.event.pull_request.merged == true
needs: set-package-matrix needs: set-package-matrix
strategy: strategy:
matrix: matrix:
@ -31,6 +30,10 @@ jobs:
url: https://pypi.org/p/${{ matrix.package-name }} url: https://pypi.org/p/${{ matrix.package-name }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with:
ref: main
python-version: '3.11'
token: ${{ secrets.CHECKOUT_PAT }}
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:

View File

@ -15,6 +15,8 @@ Each of the APIs being published includes a README file with instructions on how
* [bgp-monitors](/thousandeyes-sdk-bgp-monitors/README.md) * [bgp-monitors](/thousandeyes-sdk-bgp-monitors/README.md)
* [credentials](/thousandeyes-sdk-credentials/README.md) * [credentials](/thousandeyes-sdk-credentials/README.md)
* [dashboards](/thousandeyes-sdk-dashboards/README.md) * [dashboards](/thousandeyes-sdk-dashboards/README.md)
* [emulation](/thousandeyes-sdk-emulation/README.md)
* [event-detection](/thousandeyes-sdk-event-detection/README.md)
* [endpoint-agents](/thousandeyes-sdk-endpoint-agents/README.md) * [endpoint-agents](/thousandeyes-sdk-endpoint-agents/README.md)
* [endpoint-instant-tests](/thousandeyes-sdk-endpoint-instant-tests/README.md) * [endpoint-instant-tests](/thousandeyes-sdk-endpoint-instant-tests/README.md)
* [endpoint-labels](/thousandeyes-sdk-endpoint-labels/README.md) * [endpoint-labels](/thousandeyes-sdk-endpoint-labels/README.md)
@ -22,7 +24,6 @@ Each of the APIs being published includes a README file with instructions on how
* [endpoint-tests](/thousandeyes-sdk-endpoint-tests/README.md) * [endpoint-tests](/thousandeyes-sdk-endpoint-tests/README.md)
* [instant-tests](/thousandeyes-sdk-instant-tests/README.md) * [instant-tests](/thousandeyes-sdk-instant-tests/README.md)
* [internet-insights](/thousandeyes-sdk-internet-insights/README.md) * [internet-insights](/thousandeyes-sdk-internet-insights/README.md)
* [labels](/thousandeyes-sdk-labels/README.md)
* [snapshots](/thousandeyes-sdk-snapshots/README.md) * [snapshots](/thousandeyes-sdk-snapshots/README.md)
* [streaming](/thousandeyes-sdk-streaming/README.md) * [streaming](/thousandeyes-sdk-streaming/README.md)
* [tags](/thousandeyes-sdk-tags/README.md) * [tags](/thousandeyes-sdk-tags/README.md)

View File

@ -8,8 +8,8 @@ docs/AccountGroupRequest.md
docs/AccountGroupRole.md docs/AccountGroupRole.md
docs/AccountGroups.md docs/AccountGroups.md
docs/AccountGroupsApi.md docs/AccountGroupsApi.md
docs/Agent.md
docs/AgentBase.md docs/AgentBase.md
docs/AgentResponse.md
docs/AuditUserEvents.md docs/AuditUserEvents.md
docs/BaseRole.md docs/BaseRole.md
docs/CloudEnterpriseAgentType.md docs/CloudEnterpriseAgentType.md
@ -23,7 +23,7 @@ docs/EnterpriseAgentState.md
docs/Error.md docs/Error.md
docs/ErrorDetail.md docs/ErrorDetail.md
docs/ErrorDetailCode.md docs/ErrorDetailCode.md
docs/Expand.md docs/ExpandAccountGroupOptions.md
docs/ExtendedUser.md docs/ExtendedUser.md
docs/InterfaceIpMapping.md docs/InterfaceIpMapping.md
docs/Link.md docs/Link.md
@ -67,8 +67,8 @@ src/thousandeyes_sdk/administrative/models/account_group_info.py
src/thousandeyes_sdk/administrative/models/account_group_request.py src/thousandeyes_sdk/administrative/models/account_group_request.py
src/thousandeyes_sdk/administrative/models/account_group_role.py src/thousandeyes_sdk/administrative/models/account_group_role.py
src/thousandeyes_sdk/administrative/models/account_groups.py src/thousandeyes_sdk/administrative/models/account_groups.py
src/thousandeyes_sdk/administrative/models/agent.py
src/thousandeyes_sdk/administrative/models/agent_base.py src/thousandeyes_sdk/administrative/models/agent_base.py
src/thousandeyes_sdk/administrative/models/agent_response.py
src/thousandeyes_sdk/administrative/models/audit_user_events.py src/thousandeyes_sdk/administrative/models/audit_user_events.py
src/thousandeyes_sdk/administrative/models/base_role.py src/thousandeyes_sdk/administrative/models/base_role.py
src/thousandeyes_sdk/administrative/models/cloud_enterprise_agent_type.py src/thousandeyes_sdk/administrative/models/cloud_enterprise_agent_type.py
@ -82,7 +82,7 @@ src/thousandeyes_sdk/administrative/models/enterprise_agent_state.py
src/thousandeyes_sdk/administrative/models/error.py src/thousandeyes_sdk/administrative/models/error.py
src/thousandeyes_sdk/administrative/models/error_detail.py src/thousandeyes_sdk/administrative/models/error_detail.py
src/thousandeyes_sdk/administrative/models/error_detail_code.py src/thousandeyes_sdk/administrative/models/error_detail_code.py
src/thousandeyes_sdk/administrative/models/expand.py src/thousandeyes_sdk/administrative/models/expand_account_group_options.py
src/thousandeyes_sdk/administrative/models/extended_user.py src/thousandeyes_sdk/administrative/models/extended_user.py
src/thousandeyes_sdk/administrative/models/interface_ip_mapping.py src/thousandeyes_sdk/administrative/models/interface_ip_mapping.py
src/thousandeyes_sdk/administrative/models/link.py src/thousandeyes_sdk/administrative/models/link.py

View File

@ -1,8 +1,8 @@
# thousandeyes-sdk-administrative # thousandeyes-sdk-administrative
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API.
This API provides the following endpoints that define the operations to manage your organization: This API provides the following operations to manage your organization:
* `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups.
* `/users`: Create, retrieve, update and delete users within an organization. * `/users`: Create, retrieve, update and delete users within an organization.
* `/roles`: Create, retrieve and update roles for the current user. * `/roles`: Create, retrieve and update roles for the current user.
* `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles.
@ -12,7 +12,7 @@ This API provides the following endpoints that define the operations to manage y
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.8 - API version: 7.0.20
- Generator version: 7.6.0 - Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
@ -64,10 +64,10 @@ import thousandeyes_sdk.administrative
from thousandeyes_sdk.core.exceptions import ApiException from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -86,7 +86,7 @@ with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client) api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client)
account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest | account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest |
expand = [thousandeyes_sdk.administrative.Expand()] # List[Expand] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional) expand = [thousandeyes_sdk.administrative.ExpandAccountGroupOptions()] # List[ExpandAccountGroupOptions] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional)
try: try:
# Create account group # Create account group
@ -100,27 +100,28 @@ with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
## Documentation for API Endpoints ## Documentation for API Endpoints
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Class | Method | HTTP request | Description Class | Method | HTTP request | Description
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
*AccountGroupsApi* | [**create_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#create_account_group) | **POST** /v7/account-groups | Create account group *AccountGroupsApi* | [**create_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#create_account_group) | **POST** /account-groups | Create account group
*AccountGroupsApi* | [**delete_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#delete_account_group) | **DELETE** /v7/account-groups/{id} | Delete account group *AccountGroupsApi* | [**delete_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#delete_account_group) | **DELETE** /account-groups/{id} | Delete account group
*AccountGroupsApi* | [**get_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#get_account_group) | **GET** /v7/account-groups/{id} | Retrieve account group *AccountGroupsApi* | [**get_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#get_account_group) | **GET** /account-groups/{id} | Retrieve account group
*AccountGroupsApi* | [**get_account_groups**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#get_account_groups) | **GET** /v7/account-groups | List account groups *AccountGroupsApi* | [**get_account_groups**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#get_account_groups) | **GET** /account-groups | List account groups
*AccountGroupsApi* | [**update_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#update_account_group) | **PUT** /v7/account-groups/{id} | Update account group *AccountGroupsApi* | [**update_account_group**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupsApi.md#update_account_group) | **PUT** /account-groups/{id} | Update account group
*PermissionsApi* | [**get_permissions**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/PermissionsApi.md#get_permissions) | **GET** /v7/permissions | List assignable permissions *PermissionsApi* | [**get_permissions**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/PermissionsApi.md#get_permissions) | **GET** /permissions | List assignable permissions
*RolesApi* | [**create_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#create_role) | **POST** /v7/roles | Create role *RolesApi* | [**create_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#create_role) | **POST** /roles | Create role
*RolesApi* | [**delete_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#delete_role) | **DELETE** /v7/roles/{id} | Delete role *RolesApi* | [**delete_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#delete_role) | **DELETE** /roles/{id} | Delete role
*RolesApi* | [**get_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#get_role) | **GET** /v7/roles/{id} | Retrieve role *RolesApi* | [**get_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#get_role) | **GET** /roles/{id} | Retrieve role
*RolesApi* | [**get_roles**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#get_roles) | **GET** /v7/roles | List roles *RolesApi* | [**get_roles**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#get_roles) | **GET** /roles | List roles
*RolesApi* | [**update_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#update_role) | **PUT** /v7/roles/{id} | Update role *RolesApi* | [**update_role**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/RolesApi.md#update_role) | **PUT** /roles/{id} | Update role
*UserEventsApi* | [**get_user_events**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UserEventsApi.md#get_user_events) | **GET** /v7/audit-user-events | List activity log events *UserEventsApi* | [**get_user_events**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UserEventsApi.md#get_user_events) | **GET** /audit-user-events | List activity log events
*UsersApi* | [**create_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#create_user) | **POST** /v7/users | Create user *UsersApi* | [**create_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#create_user) | **POST** /users | Create user
*UsersApi* | [**delete_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#delete_user) | **DELETE** /v7/users/{id} | Delete user *UsersApi* | [**delete_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#delete_user) | **DELETE** /users/{id} | Delete user
*UsersApi* | [**get_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#get_user) | **GET** /v7/users/{id} | Retrieve user *UsersApi* | [**get_current_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#get_current_user) | **GET** /users/current | Retrieve current user
*UsersApi* | [**get_users**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#get_users) | **GET** /v7/users | List users *UsersApi* | [**get_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#get_user) | **GET** /users/{id} | Retrieve user
*UsersApi* | [**update_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#update_user) | **PUT** /v7/users/{id} | Update user *UsersApi* | [**get_users**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#get_users) | **GET** /users | List users
*UsersApi* | [**update_user**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/UsersApi.md#update_user) | **PUT** /users/{id} | Update user
## Documentation For Models ## Documentation For Models
@ -131,8 +132,8 @@ Class | Method | HTTP request | Description
- [AccountGroupRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupRequest.md) - [AccountGroupRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupRequest.md)
- [AccountGroupRole](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupRole.md) - [AccountGroupRole](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroupRole.md)
- [AccountGroups](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroups.md) - [AccountGroups](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AccountGroups.md)
- [Agent](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Agent.md)
- [AgentBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AgentBase.md) - [AgentBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AgentBase.md)
- [AgentResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AgentResponse.md)
- [AuditUserEvents](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AuditUserEvents.md) - [AuditUserEvents](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/AuditUserEvents.md)
- [BaseRole](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/BaseRole.md) - [BaseRole](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/BaseRole.md)
- [CloudEnterpriseAgentType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/CloudEnterpriseAgentType.md) - [CloudEnterpriseAgentType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/CloudEnterpriseAgentType.md)
@ -146,7 +147,7 @@ Class | Method | HTTP request | Description
- [Error](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Error.md) - [Error](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Error.md)
- [ErrorDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ErrorDetail.md) - [ErrorDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ErrorDetail.md)
- [ErrorDetailCode](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ErrorDetailCode.md) - [ErrorDetailCode](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ErrorDetailCode.md)
- [Expand](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Expand.md) - [ExpandAccountGroupOptions](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ExpandAccountGroupOptions.md)
- [ExtendedUser](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ExtendedUser.md) - [ExtendedUser](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/ExtendedUser.md)
- [InterfaceIpMapping](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/InterfaceIpMapping.md) - [InterfaceIpMapping](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/InterfaceIpMapping.md)
- [Link](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Link.md) - [Link](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-administrative/docs/Link.md)

View File

@ -13,6 +13,7 @@ Name | Type | Description | Notes
**users** | [**List[UserAccountGroup]**](UserAccountGroup.md) | | [optional] **users** | [**List[UserAccountGroup]**](UserAccountGroup.md) | | [optional]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]
**agents** | [**List[EnterpriseAgent]**](EnterpriseAgent.md) | | [optional] **agents** | [**List[EnterpriseAgent]**](EnterpriseAgent.md) | | [optional]
**account_token** | **str** | The account group token is an alphanumeric string used to bind an Enterprise Agent to a specific account group. This token is not a password that must be kept secret. You can retrieve your `AccountGroupToken` from the `/account-groups/{id}` endpoint. | [optional]
## Example ## Example

View File

@ -1,14 +1,14 @@
# thousandeyes_sdk.administrative.AccountGroupsApi # thousandeyes_sdk.administrative.AccountGroupsApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**create_account_group**](AccountGroupsApi.md#create_account_group) | **POST** /v7/account-groups | Create account group [**create_account_group**](AccountGroupsApi.md#create_account_group) | **POST** /account-groups | Create account group
[**delete_account_group**](AccountGroupsApi.md#delete_account_group) | **DELETE** /v7/account-groups/{id} | Delete account group [**delete_account_group**](AccountGroupsApi.md#delete_account_group) | **DELETE** /account-groups/{id} | Delete account group
[**get_account_group**](AccountGroupsApi.md#get_account_group) | **GET** /v7/account-groups/{id} | Retrieve account group [**get_account_group**](AccountGroupsApi.md#get_account_group) | **GET** /account-groups/{id} | Retrieve account group
[**get_account_groups**](AccountGroupsApi.md#get_account_groups) | **GET** /v7/account-groups | List account groups [**get_account_groups**](AccountGroupsApi.md#get_account_groups) | **GET** /account-groups | List account groups
[**update_account_group**](AccountGroupsApi.md#update_account_group) | **PUT** /v7/account-groups/{id} | Update account group [**update_account_group**](AccountGroupsApi.md#update_account_group) | **PUT** /account-groups/{id} | Update account group
# **create_account_group** # **create_account_group**
@ -26,14 +26,14 @@ Creates a new account group. This operation requires the `Edit all account group
import thousandeyes_sdk.administrative import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest
from thousandeyes_sdk.administrative.models.created_account_group import CreatedAccountGroup from thousandeyes_sdk.administrative.models.created_account_group import CreatedAccountGroup
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -51,7 +51,7 @@ with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client) api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client)
account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest | account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest |
expand = [thousandeyes_sdk.administrative.Expand()] # List[Expand] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional) expand = [thousandeyes_sdk.administrative.ExpandAccountGroupOptions()] # List[ExpandAccountGroupOptions] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional)
try: try:
# Create account group # Create account group
@ -70,7 +70,7 @@ with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**account_group_request** | [**AccountGroupRequest**](AccountGroupRequest.md)| | **account_group_request** | [**AccountGroupRequest**](AccountGroupRequest.md)| |
**expand** | [**List[Expand]**](Expand.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional] **expand** | [**List[ExpandAccountGroupOptions]**](ExpandAccountGroupOptions.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional]
### Return type ### Return type
@ -115,10 +115,10 @@ import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -194,14 +194,14 @@ Retrieves detailed information about an account group using its ID. This operat
```python ```python
import thousandeyes_sdk.administrative import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.models.account_group_detail import AccountGroupDetail from thousandeyes_sdk.administrative.models.account_group_detail import AccountGroupDetail
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -219,7 +219,7 @@ with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client) api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client)
id = '1234' # str | Identifier for the account group. id = '1234' # str | Identifier for the account group.
expand = [thousandeyes_sdk.administrative.Expand()] # List[Expand] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional) expand = [thousandeyes_sdk.administrative.ExpandAccountGroupOptions()] # List[ExpandAccountGroupOptions] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional)
try: try:
# Retrieve account group # Retrieve account group
@ -238,7 +238,7 @@ with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **str**| Identifier for the account group. | **id** | **str**| Identifier for the account group. |
**expand** | [**List[Expand]**](Expand.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional] **expand** | [**List[ExpandAccountGroupOptions]**](ExpandAccountGroupOptions.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional]
### Return type ### Return type
@ -284,10 +284,10 @@ from thousandeyes_sdk.administrative.models.account_groups import AccountGroups
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -366,14 +366,14 @@ Updates an account group using its ID. You can modify the account groups name
import thousandeyes_sdk.administrative import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.models.account_group_detail import AccountGroupDetail from thousandeyes_sdk.administrative.models.account_group_detail import AccountGroupDetail
from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -392,7 +392,7 @@ with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client) api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client)
id = '1234' # str | Identifier for the account group. id = '1234' # str | Identifier for the account group.
account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest | account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest |
expand = [thousandeyes_sdk.administrative.Expand()] # List[Expand] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional) expand = [thousandeyes_sdk.administrative.ExpandAccountGroupOptions()] # List[ExpandAccountGroupOptions] | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. (optional)
try: try:
# Update account group # Update account group
@ -412,7 +412,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **str**| Identifier for the account group. | **id** | **str**| Identifier for the account group. |
**account_group_request** | [**AccountGroupRequest**](AccountGroupRequest.md)| | **account_group_request** | [**AccountGroupRequest**](AccountGroupRequest.md)| |
**expand** | [**List[Expand]**](Expand.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional] **expand** | [**List[ExpandAccountGroupOptions]**](ExpandAccountGroupOptions.md)| Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. | [optional]
### Return type ### Return type

View File

@ -1,4 +1,4 @@
# Agent # AgentResponse
## Properties ## Properties
@ -20,19 +20,19 @@ Name | Type | Description | Notes
## Example ## Example
```python ```python
from thousandeyes_sdk.tests.models.agent import Agent from thousandeyes_sdk.administrative.models.agent_response import AgentResponse
# TODO update the JSON string below # TODO update the JSON string below
json = "{}" json = "{}"
# create an instance of Agent from a JSON string # create an instance of AgentResponse from a JSON string
agent_instance = Agent.from_json(json) agent_response_instance = AgentResponse.from_json(json)
# print the JSON string representation of the object # print the JSON string representation of the object
print(Agent.to_json()) print(AgentResponse.to_json())
# convert the object into a dict # convert the object into a dict
agent_dict = agent_instance.to_dict() agent_response_dict = agent_response_instance.to_dict()
# create an instance of Agent from a dict # create an instance of AgentResponse from a dict
agent_from_dict = Agent.from_dict(agent_dict) agent_response_from_dict = AgentResponse.from_dict(agent_response_dict)
``` ```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,11 @@
# ExpandAccountGroupOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,10 +1,10 @@
# thousandeyes_sdk.administrative.PermissionsApi # thousandeyes_sdk.administrative.PermissionsApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**get_permissions**](PermissionsApi.md#get_permissions) | **GET** /v7/permissions | List assignable permissions [**get_permissions**](PermissionsApi.md#get_permissions) | **GET** /permissions | List assignable permissions
# **get_permissions** # **get_permissions**
@ -12,7 +12,7 @@ Method | HTTP request | Description
List assignable permissions List assignable permissions
Users must be in a role assigned management permissions to access this endpoint. Users without management permissions who attempt to access this endpoint receive an HTTP/403 response code. Users must be in a role assigned management permissions to access this operation. Users without management permissions who attempt to access this operation receive an HTTP/403 response code.
### Example ### Example
@ -24,10 +24,10 @@ from thousandeyes_sdk.administrative.models.permissions import Permissions
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -6,7 +6,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the role. | [optional] **name** | **str** | Name of the role. | [optional]
**permissions** | **List[str]** | Contains list of test permission IDs (get `permissionId` from `/permissions` endpoint) | [optional] **permissions** | **List[str]** | Contains list of test permission IDs (get `permissionId` from `/permissions` operation) | [optional]
## Example ## Example

View File

@ -1,14 +1,14 @@
# thousandeyes_sdk.administrative.RolesApi # thousandeyes_sdk.administrative.RolesApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**create_role**](RolesApi.md#create_role) | **POST** /v7/roles | Create role [**create_role**](RolesApi.md#create_role) | **POST** /roles | Create role
[**delete_role**](RolesApi.md#delete_role) | **DELETE** /v7/roles/{id} | Delete role [**delete_role**](RolesApi.md#delete_role) | **DELETE** /roles/{id} | Delete role
[**get_role**](RolesApi.md#get_role) | **GET** /v7/roles/{id} | Retrieve role [**get_role**](RolesApi.md#get_role) | **GET** /roles/{id} | Retrieve role
[**get_roles**](RolesApi.md#get_roles) | **GET** /v7/roles | List roles [**get_roles**](RolesApi.md#get_roles) | **GET** /roles | List roles
[**update_role**](RolesApi.md#update_role) | **PUT** /v7/roles/{id} | Update role [**update_role**](RolesApi.md#update_role) | **PUT** /roles/{id} | Update role
# **create_role** # **create_role**
@ -29,10 +29,10 @@ from thousandeyes_sdk.administrative.models.role_request_body import RoleRequest
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -103,7 +103,7 @@ Name | Type | Description | Notes
Delete role Delete role
Deletes a role using its ID. The user needs appropriate permissions to successfully call this endpoint. Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.
### Example ### Example
@ -114,10 +114,10 @@ import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -198,10 +198,10 @@ from thousandeyes_sdk.administrative.models.role_detail import RoleDetail
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -284,10 +284,10 @@ from thousandeyes_sdk.administrative.models.roles import Roles
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -356,7 +356,7 @@ Name | Type | Description | Notes
Update role Update role
Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This endpoint does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions endpoint. Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.
### Example ### Example
@ -369,10 +369,10 @@ from thousandeyes_sdk.administrative.models.role_request_body import RoleRequest
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -1,10 +1,10 @@
# thousandeyes_sdk.administrative.UserEventsApi # thousandeyes_sdk.administrative.UserEventsApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**get_user_events**](UserEventsApi.md#get_user_events) | **GET** /v7/audit-user-events | List activity log events [**get_user_events**](UserEventsApi.md#get_user_events) | **GET** /audit-user-events | List activity log events
# **get_user_events** # **get_user_events**
@ -24,10 +24,10 @@ from thousandeyes_sdk.administrative.models.audit_user_events import AuditUserEv
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -1,14 +1,15 @@
# thousandeyes_sdk.administrative.UsersApi # thousandeyes_sdk.administrative.UsersApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**create_user**](UsersApi.md#create_user) | **POST** /v7/users | Create user [**create_user**](UsersApi.md#create_user) | **POST** /users | Create user
[**delete_user**](UsersApi.md#delete_user) | **DELETE** /v7/users/{id} | Delete user [**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{id} | Delete user
[**get_user**](UsersApi.md#get_user) | **GET** /v7/users/{id} | Retrieve user [**get_current_user**](UsersApi.md#get_current_user) | **GET** /users/current | Retrieve current user
[**get_users**](UsersApi.md#get_users) | **GET** /v7/users | List users [**get_user**](UsersApi.md#get_user) | **GET** /users/{id} | Retrieve user
[**update_user**](UsersApi.md#update_user) | **PUT** /v7/users/{id} | Update user [**get_users**](UsersApi.md#get_users) | **GET** /users | List users
[**update_user**](UsersApi.md#update_user) | **PUT** /users/{id} | Update user
# **create_user** # **create_user**
@ -29,10 +30,10 @@ from thousandeyes_sdk.administrative.models.user_request import UserRequest
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -103,7 +104,7 @@ Name | Type | Description | Notes
Delete user Delete user
Deletes a user using the user ID. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. Deletes a user using the user ID. This operation requires the `Edit users in all account groups` or `Edit users` permission.
### Example ### Example
@ -114,10 +115,10 @@ import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -181,6 +182,86 @@ void (empty response body)
[[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) [[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_current_user**
> UserDetail get_current_user()
Retrieve current user
Retrieves detailed information about the current user.
### Example
* Bearer Authentication (BearerAuth):
```python
import thousandeyes_sdk.administrative
from thousandeyes_sdk.administrative.models.user_detail import UserDetail
from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com/v7"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with thousandeyes_sdk.administrative.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = thousandeyes_sdk.administrative.UsersApi(api_client)
try:
# Retrieve current user
api_response = api_instance.get_current_user()
print("The response of UsersApi->get_current_user:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling UsersApi->get_current_user: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**UserDetail**](UserDetail.md)
### Authorization
[BearerAuth](../README.md#BearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/hal+json, application/json, application/problem+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**400** | Bad Request | - |
**401** | Unauthorized | - |
**403** | Insufficient permissions to query endpoint | - |
**404** | Not found | - |
**429** | Exhausted rate limit for the organization | - |
**500** | Internal server error | - |
[[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_user** # **get_user**
> UserDetail get_user(id, aid=aid) > UserDetail get_user(id, aid=aid)
@ -198,10 +279,10 @@ from thousandeyes_sdk.administrative.models.user_detail import UserDetail
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -284,10 +365,10 @@ from thousandeyes_sdk.administrative.models.users import Users
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -356,7 +437,7 @@ Name | Type | Description | Notes
Update user Update user
Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update. Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This operation requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update.
### Example ### Example
@ -369,10 +450,10 @@ from thousandeyes_sdk.administrative.models.user_request import UserRequest
from thousandeyes_sdk.administrative.rest import ApiException from thousandeyes_sdk.administrative.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -9,9 +9,9 @@ description = "ThousandEyes SDK Administrative API"
license = { file = "LICENSE" } license = { file = "LICENSE" }
requires-python = ">= 3.8" requires-python = ">= 3.8"
dependencies = [ dependencies = [
"urllib3 >= 1.25.3", "urllib3 >= 2.0.0",
"python-dateutil >=2.8.2", "python-dateutil >=2.8.2",
"pydantic >=2", "pydantic >=2.1.0",
"typing-extensions >=4.7.1", "typing-extensions >=4.7.1",
"thousandeyes-sdk-core", "thousandeyes-sdk-core",
] ]

View File

@ -5,9 +5,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -29,8 +28,8 @@ from thousandeyes_sdk.administrative.models.account_group_info import AccountGro
from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest
from thousandeyes_sdk.administrative.models.account_group_role import AccountGroupRole from thousandeyes_sdk.administrative.models.account_group_role import AccountGroupRole
from thousandeyes_sdk.administrative.models.account_groups import AccountGroups from thousandeyes_sdk.administrative.models.account_groups import AccountGroups
from thousandeyes_sdk.administrative.models.agent import Agent
from thousandeyes_sdk.administrative.models.agent_base import AgentBase from thousandeyes_sdk.administrative.models.agent_base import AgentBase
from thousandeyes_sdk.administrative.models.agent_response import AgentResponse
from thousandeyes_sdk.administrative.models.audit_user_events import AuditUserEvents from thousandeyes_sdk.administrative.models.audit_user_events import AuditUserEvents
from thousandeyes_sdk.administrative.models.base_role import BaseRole from thousandeyes_sdk.administrative.models.base_role import BaseRole
from thousandeyes_sdk.administrative.models.cloud_enterprise_agent_type import CloudEnterpriseAgentType from thousandeyes_sdk.administrative.models.cloud_enterprise_agent_type import CloudEnterpriseAgentType
@ -44,7 +43,7 @@ from thousandeyes_sdk.administrative.models.enterprise_agent_state import Enterp
from thousandeyes_sdk.administrative.models.error import Error from thousandeyes_sdk.administrative.models.error import Error
from thousandeyes_sdk.administrative.models.error_detail import ErrorDetail from thousandeyes_sdk.administrative.models.error_detail import ErrorDetail
from thousandeyes_sdk.administrative.models.error_detail_code import ErrorDetailCode from thousandeyes_sdk.administrative.models.error_detail_code import ErrorDetailCode
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.administrative.models.extended_user import ExtendedUser from thousandeyes_sdk.administrative.models.extended_user import ExtendedUser
from thousandeyes_sdk.administrative.models.interface_ip_mapping import InterfaceIpMapping from thousandeyes_sdk.administrative.models.interface_ip_mapping import InterfaceIpMapping
from thousandeyes_sdk.administrative.models.link import Link from thousandeyes_sdk.administrative.models.link import Link

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -26,7 +25,7 @@ from thousandeyes_sdk.administrative.models.account_group_detail import AccountG
from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest
from thousandeyes_sdk.administrative.models.account_groups import AccountGroups from thousandeyes_sdk.administrative.models.account_groups import AccountGroups
from thousandeyes_sdk.administrative.models.created_account_group import CreatedAccountGroup from thousandeyes_sdk.administrative.models.created_account_group import CreatedAccountGroup
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.core.api_client import ApiClient, RequestSerialized from thousandeyes_sdk.core.api_client import ApiClient, RequestSerialized
from thousandeyes_sdk.core.api_response import ApiResponse from thousandeyes_sdk.core.api_response import ApiResponse
@ -51,7 +50,7 @@ class AccountGroupsApi:
def create_account_group( def create_account_group(
self, self,
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -72,7 +71,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -129,7 +128,7 @@ class AccountGroupsApi:
def create_account_group_with_http_info( def create_account_group_with_http_info(
self, self,
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -150,7 +149,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -207,7 +206,7 @@ class AccountGroupsApi:
def create_account_group_without_preload_content( def create_account_group_without_preload_content(
self, self,
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -228,7 +227,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -342,7 +341,7 @@ class AccountGroupsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='POST', method='POST',
resource_path='/v7/account-groups', resource_path='/account-groups',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -621,7 +620,7 @@ class AccountGroupsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='DELETE', method='DELETE',
resource_path='/v7/account-groups/{id}', resource_path='/account-groups/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -641,7 +640,7 @@ class AccountGroupsApi:
def get_account_group( def get_account_group(
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -662,7 +661,7 @@ class AccountGroupsApi:
:param id: Identifier for the account group. (required) :param id: Identifier for the account group. (required)
:type id: str :type id: str
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -719,7 +718,7 @@ class AccountGroupsApi:
def get_account_group_with_http_info( def get_account_group_with_http_info(
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -740,7 +739,7 @@ class AccountGroupsApi:
:param id: Identifier for the account group. (required) :param id: Identifier for the account group. (required)
:type id: str :type id: str
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -797,7 +796,7 @@ class AccountGroupsApi:
def get_account_group_without_preload_content( def get_account_group_without_preload_content(
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -818,7 +817,7 @@ class AccountGroupsApi:
:param id: Identifier for the account group. (required) :param id: Identifier for the account group. (required)
:type id: str :type id: str
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -919,7 +918,7 @@ class AccountGroupsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/account-groups/{id}', resource_path='/account-groups/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1201,7 +1200,7 @@ class AccountGroupsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/account-groups', resource_path='/account-groups',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1222,7 +1221,7 @@ class AccountGroupsApi:
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -1245,7 +1244,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -1304,7 +1303,7 @@ class AccountGroupsApi:
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -1327,7 +1326,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -1386,7 +1385,7 @@ class AccountGroupsApi:
self, self,
id: Annotated[StrictStr, Field(description="Identifier for the account group.")], id: Annotated[StrictStr, Field(description="Identifier for the account group.")],
account_group_request: AccountGroupRequest, account_group_request: AccountGroupRequest,
expand: Annotated[Optional[List[Expand]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None, expand: Annotated[Optional[List[ExpandAccountGroupOptions]], Field(description="Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.")] = None,
_request_timeout: Union[ _request_timeout: Union[
None, None,
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)],
@ -1409,7 +1408,7 @@ class AccountGroupsApi:
:param account_group_request: (required) :param account_group_request: (required)
:type account_group_request: AccountGroupRequest :type account_group_request: AccountGroupRequest
:param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query. :param expand: Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
:type expand: List[Expand] :type expand: List[ExpandAccountGroupOptions]
:param _request_timeout: timeout setting for this request. If one :param _request_timeout: timeout setting for this request. If one
number provided, it will be total request number provided, it will be total request
timeout. It can also be a pair (tuple) of timeout. It can also be a pair (tuple) of
@ -1527,7 +1526,7 @@ class AccountGroupsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='PUT', method='PUT',
resource_path='/v7/account-groups/{id}', resource_path='/account-groups/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -62,7 +61,7 @@ class PermissionsApi:
) -> Permissions: ) -> Permissions:
"""List assignable permissions """List assignable permissions
Users must be in a role assigned management permissions to access this endpoint. Users without management permissions who attempt to access this endpoint receive an HTTP/403 response code. Users must be in a role assigned management permissions to access this operation. Users without management permissions who attempt to access this operation receive an HTTP/403 response code.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -136,7 +135,7 @@ class PermissionsApi:
) -> ApiResponse[Permissions]: ) -> ApiResponse[Permissions]:
"""List assignable permissions """List assignable permissions
Users must be in a role assigned management permissions to access this endpoint. Users without management permissions who attempt to access this endpoint receive an HTTP/403 response code. Users must be in a role assigned management permissions to access this operation. Users without management permissions who attempt to access this operation receive an HTTP/403 response code.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -210,7 +209,7 @@ class PermissionsApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""List assignable permissions """List assignable permissions
Users must be in a role assigned management permissions to access this endpoint. Users without management permissions who attempt to access this endpoint receive an HTTP/403 response code. Users must be in a role assigned management permissions to access this operation. Users without management permissions who attempt to access this operation receive an HTTP/403 response code.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -309,7 +308,7 @@ class PermissionsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/permissions', resource_path='/permissions',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -339,7 +338,7 @@ class RolesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='POST', method='POST',
resource_path='/v7/roles', resource_path='/roles',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -375,7 +374,7 @@ class RolesApi:
) -> None: ) -> None:
"""Delete role """Delete role
Deletes a role using its ID. The user needs appropriate permissions to successfully call this endpoint. Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -453,7 +452,7 @@ class RolesApi:
) -> ApiResponse[None]: ) -> ApiResponse[None]:
"""Delete role """Delete role
Deletes a role using its ID. The user needs appropriate permissions to successfully call this endpoint. Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -531,7 +530,7 @@ class RolesApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Delete role """Delete role
Deletes a role using its ID. The user needs appropriate permissions to successfully call this endpoint. Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -635,7 +634,7 @@ class RolesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='DELETE', method='DELETE',
resource_path='/v7/roles/{id}', resource_path='/roles/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -932,7 +931,7 @@ class RolesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/roles/{id}', resource_path='/roles/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1214,7 +1213,7 @@ class RolesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/roles', resource_path='/roles',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1251,7 +1250,7 @@ class RolesApi:
) -> RoleDetail: ) -> RoleDetail:
"""Update role """Update role
Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This endpoint does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions endpoint. Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -1333,7 +1332,7 @@ class RolesApi:
) -> ApiResponse[RoleDetail]: ) -> ApiResponse[RoleDetail]:
"""Update role """Update role
Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This endpoint does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions endpoint. Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -1415,7 +1414,7 @@ class RolesApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Update role """Update role
Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This endpoint does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions endpoint. Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.
:param id: The ID of the desired role. (required) :param id: The ID of the desired role. (required)
:type id: str :type id: str
@ -1539,7 +1538,7 @@ class RolesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='PUT', method='PUT',
resource_path='/v7/roles/{id}', resource_path='/roles/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -413,7 +412,7 @@ class UserEventsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/audit-user-events', resource_path='/audit-user-events',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -340,7 +339,7 @@ class UsersApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='POST', method='POST',
resource_path='/v7/users', resource_path='/users',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -376,7 +375,7 @@ class UsersApi:
) -> None: ) -> None:
"""Delete user """Delete user
Deletes a user using the user ID. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. Deletes a user using the user ID. This operation requires the `Edit users in all account groups` or `Edit users` permission.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -454,7 +453,7 @@ class UsersApi:
) -> ApiResponse[None]: ) -> ApiResponse[None]:
"""Delete user """Delete user
Deletes a user using the user ID. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. Deletes a user using the user ID. This operation requires the `Edit users in all account groups` or `Edit users` permission.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -532,7 +531,7 @@ class UsersApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Delete user """Delete user
Deletes a user using the user ID. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. Deletes a user using the user ID. This operation requires the `Edit users in all account groups` or `Edit users` permission.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -636,7 +635,272 @@ class UsersApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='DELETE', method='DELETE',
resource_path='/v7/users/{id}', resource_path='/users/{id}',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def get_current_user(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> UserDetail:
"""Retrieve current user
Retrieves detailed information about the current user.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_current_user_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "UserDetail",
'400': "ValidationError",
'401': "UnauthorizedError",
'403': "Error",
'404': "Error",
'429': "Error",
'500': "Error",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
models=thousandeyes_sdk.administrative.models,
).data
@validate_call
def get_current_user_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[UserDetail]:
"""Retrieve current user
Retrieves detailed information about the current user.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_current_user_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "UserDetail",
'400': "ValidationError",
'401': "UnauthorizedError",
'403': "Error",
'404': "Error",
'429': "Error",
'500': "Error",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
models=thousandeyes_sdk.administrative.models,
)
@validate_call
def get_current_user_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Retrieve current user
Retrieves detailed information about the current user.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_current_user_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "UserDetail",
'400': "ValidationError",
'401': "UnauthorizedError",
'403': "Error",
'404': "Error",
'429': "Error",
'500': "Error",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_current_user_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[str, Union[str, bytes]] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/hal+json',
'application/json',
'application/problem+json'
]
)
# authentication setting
_auth_settings: List[str] = [
'BearerAuth'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/users/current',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -933,7 +1197,7 @@ class UsersApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/users/{id}', resource_path='/users/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1215,7 +1479,7 @@ class UsersApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/users', resource_path='/users',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -1252,7 +1516,7 @@ class UsersApi:
) -> UserDetail: ) -> UserDetail:
"""Update user """Update user
Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update. Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This operation requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -1334,7 +1598,7 @@ class UsersApi:
) -> ApiResponse[UserDetail]: ) -> ApiResponse[UserDetail]:
"""Update user """Update user
Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update. Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This operation requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -1416,7 +1680,7 @@ class UsersApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Update user """Update user
Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This endpoint requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update. Updates a user using the user ID. You can update the user name, email address, account group assignments, or roles. This operation requires the `Edit users in all account groups` or `Edit users` permission. When updating a user, the following applies: * When updating a user's email address, the user must confirm the username change before they can subsequently log in or perform API operations. * Any update that includes `accountGroupRoles` is a replace-based update and not a delta-based update.
:param id: Identifier for the user. (required) :param id: Identifier for the user. (required)
:type id: str :type id: str
@ -1540,7 +1804,7 @@ class UsersApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='PUT', method='PUT',
resource_path='/v7/users/{id}', resource_path='/users/{id}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -4,9 +4,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -20,8 +19,8 @@ from thousandeyes_sdk.administrative.models.account_group_info import AccountGro
from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest from thousandeyes_sdk.administrative.models.account_group_request import AccountGroupRequest
from thousandeyes_sdk.administrative.models.account_group_role import AccountGroupRole from thousandeyes_sdk.administrative.models.account_group_role import AccountGroupRole
from thousandeyes_sdk.administrative.models.account_groups import AccountGroups from thousandeyes_sdk.administrative.models.account_groups import AccountGroups
from thousandeyes_sdk.administrative.models.agent import Agent
from thousandeyes_sdk.administrative.models.agent_base import AgentBase from thousandeyes_sdk.administrative.models.agent_base import AgentBase
from thousandeyes_sdk.administrative.models.agent_response import AgentResponse
from thousandeyes_sdk.administrative.models.audit_user_events import AuditUserEvents from thousandeyes_sdk.administrative.models.audit_user_events import AuditUserEvents
from thousandeyes_sdk.administrative.models.base_role import BaseRole from thousandeyes_sdk.administrative.models.base_role import BaseRole
from thousandeyes_sdk.administrative.models.cloud_enterprise_agent_type import CloudEnterpriseAgentType from thousandeyes_sdk.administrative.models.cloud_enterprise_agent_type import CloudEnterpriseAgentType
@ -35,7 +34,7 @@ from thousandeyes_sdk.administrative.models.enterprise_agent_state import Enterp
from thousandeyes_sdk.administrative.models.error import Error from thousandeyes_sdk.administrative.models.error import Error
from thousandeyes_sdk.administrative.models.error_detail import ErrorDetail from thousandeyes_sdk.administrative.models.error_detail import ErrorDetail
from thousandeyes_sdk.administrative.models.error_detail_code import ErrorDetailCode from thousandeyes_sdk.administrative.models.error_detail_code import ErrorDetailCode
from thousandeyes_sdk.administrative.models.expand import Expand from thousandeyes_sdk.administrative.models.expand_account_group_options import ExpandAccountGroupOptions
from thousandeyes_sdk.administrative.models.extended_user import ExtendedUser from thousandeyes_sdk.administrative.models.extended_user import ExtendedUser
from thousandeyes_sdk.administrative.models.interface_ip_mapping import InterfaceIpMapping from thousandeyes_sdk.administrative.models.interface_ip_mapping import InterfaceIpMapping
from thousandeyes_sdk.administrative.models.link import Link from thousandeyes_sdk.administrative.models.link import Link

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -37,7 +36,8 @@ class AccountGroupDetail(BaseModel):
users: Optional[List[UserAccountGroup]] = None users: Optional[List[UserAccountGroup]] = None
links: Optional[SelfLinks] = Field(default=None, alias="_links") links: Optional[SelfLinks] = Field(default=None, alias="_links")
agents: Optional[List[EnterpriseAgent]] = None agents: Optional[List[EnterpriseAgent]] = None
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "users", "_links", "agents"] account_token: Optional[StrictStr] = Field(default=None, description="The account group token is an alphanumeric string used to bind an Enterprise Agent to a specific account group. This token is not a password that must be kept secret. You can retrieve your `AccountGroupToken` from the `/account-groups/{id}` endpoint.", alias="accountToken")
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "users", "_links", "agents", "accountToken"]
model_config = ConfigDict( model_config = ConfigDict(
populate_by_name=True, populate_by_name=True,
@ -115,7 +115,8 @@ class AccountGroupDetail(BaseModel):
"organizationName": obj.get("organizationName"), "organizationName": obj.get("organizationName"),
"users": [UserAccountGroup.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None, "users": [UserAccountGroup.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None,
"_links": SelfLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None, "_links": SelfLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
"agents": [EnterpriseAgent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None "agents": [EnterpriseAgent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None,
"accountToken": obj.get("accountToken")
}) })
return _obj return _obj

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -23,9 +22,9 @@ from thousandeyes_sdk.administrative.models.cloud_enterprise_agent_type import C
from typing import Optional, Set from typing import Optional, Set
from typing_extensions import Self from typing_extensions import Self
class Agent(BaseModel): class AgentResponse(BaseModel):
""" """
Agent AgentResponse
""" # noqa: E501 """ # noqa: E501
ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of private IP addresses.", alias="ipAddresses") ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of private IP addresses.", alias="ipAddresses")
public_ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of public IP addresses.", alias="publicIpAddresses") public_ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of public IP addresses.", alias="publicIpAddresses")
@ -59,7 +58,7 @@ class Agent(BaseModel):
@classmethod @classmethod
def from_json(cls, json_str: str) -> Optional[Self]: def from_json(cls, json_str: str) -> Optional[Self]:
"""Create an instance of Agent from a JSON string""" """Create an instance of AgentResponse from a JSON string"""
return cls.from_dict(json.loads(json_str)) return cls.from_dict(json.loads(json_str))
def to_dict(self) -> Dict[str, Any]: def to_dict(self) -> Dict[str, Any]:
@ -100,7 +99,7 @@ class Agent(BaseModel):
@classmethod @classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of Agent from a dict""" """Create an instance of AgentResponse from a dict"""
if obj is None: if obj is None:
return None return None

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -29,10 +28,15 @@ class CloudEnterpriseAgentType(str, Enum):
CLOUD = 'cloud' CLOUD = 'cloud'
ENTERPRISE_MINUS_CLUSTER = 'enterprise-cluster' ENTERPRISE_MINUS_CLUSTER = 'enterprise-cluster'
ENTERPRISE = 'enterprise' ENTERPRISE = 'enterprise'
UNKNOWN = 'unknown'
@classmethod @classmethod
def from_json(cls, json_str: str) -> Self: def from_json(cls, json_str: str) -> Self:
"""Create an instance of CloudEnterpriseAgentType from a JSON string""" """Create an instance of CloudEnterpriseAgentType from a JSON string"""
return cls(json.loads(json_str)) return cls(json.loads(json_str))
@classmethod
def _missing_(cls, value):
"""Handle unknown values"""
return cls.UNKNOWN

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -29,10 +28,15 @@ class EnterpriseAgentIpv6Policy(str, Enum):
FORCE_MINUS_IPV4 = 'force-ipv4' FORCE_MINUS_IPV4 = 'force-ipv4'
PREFER_MINUS_IPV6 = 'prefer-ipv6' PREFER_MINUS_IPV6 = 'prefer-ipv6'
FORCE_MINUS_IPV6 = 'force-ipv6' FORCE_MINUS_IPV6 = 'force-ipv6'
UNKNOWN = 'unknown'
@classmethod @classmethod
def from_json(cls, json_str: str) -> Self: def from_json(cls, json_str: str) -> Self:
"""Create an instance of EnterpriseAgentIpv6Policy from a JSON string""" """Create an instance of EnterpriseAgentIpv6Policy from a JSON string"""
return cls(json.loads(json_str)) return cls(json.loads(json_str))
@classmethod
def _missing_(cls, value):
"""Handle unknown values"""
return cls.UNKNOWN

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -29,10 +28,15 @@ class EnterpriseAgentState(str, Enum):
ONLINE = 'online' ONLINE = 'online'
OFFLINE = 'offline' OFFLINE = 'offline'
DISABLED = 'disabled' DISABLED = 'disabled'
UNKNOWN = 'unknown'
@classmethod @classmethod
def from_json(cls, json_str: str) -> Self: def from_json(cls, json_str: str) -> Self:
"""Create an instance of EnterpriseAgentState from a JSON string""" """Create an instance of EnterpriseAgentState from a JSON string"""
return cls(json.loads(json_str)) return cls(json.loads(json_str))
@classmethod
def _missing_(cls, value):
"""Handle unknown values"""
return cls.UNKNOWN

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -34,10 +33,15 @@ class ErrorDetailCode(str, Enum):
OS_MINUS_END_MINUS_OF_MINUS_SUPPORT = 'os-end-of-support' OS_MINUS_END_MINUS_OF_MINUS_SUPPORT = 'os-end-of-support'
OS_MINUS_END_MINUS_OF_MINUS_LIFE = 'os-end-of-life' OS_MINUS_END_MINUS_OF_MINUS_LIFE = 'os-end-of-life'
NAT_MINUS_TRAVERSAL_MINUS_ERROR = 'nat-traversal-error' NAT_MINUS_TRAVERSAL_MINUS_ERROR = 'nat-traversal-error'
UNKNOWN = 'unknown'
@classmethod @classmethod
def from_json(cls, json_str: str) -> Self: def from_json(cls, json_str: str) -> Self:
"""Create an instance of ErrorDetailCode from a JSON string""" """Create an instance of ErrorDetailCode from a JSON string"""
return cls(json.loads(json_str)) return cls(json.loads(json_str))
@classmethod
def _missing_(cls, value):
"""Handle unknown values"""
return cls.UNKNOWN

View File

@ -1,37 +0,0 @@
# coding: utf-8
"""
Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from __future__ import annotations
import json
from enum import Enum
from typing_extensions import Self
class Expand(str, Enum):
"""
Expand
"""
"""
allowed enum values
"""
USER = 'user'
AGENT = 'agent'
@classmethod
def from_json(cls, json_str: str) -> Self:
"""Create an instance of Expand from a JSON string"""
return cls(json.loads(json_str))

View File

@ -0,0 +1,41 @@
# coding: utf-8
"""
Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from __future__ import annotations
import json
from enum import Enum
from typing_extensions import Self
class ExpandAccountGroupOptions(str, Enum):
"""
ExpandAccountGroupOptions
"""
"""
allowed enum values
"""
USER = 'user'
AGENT = 'agent'
UNKNOWN = 'unknown'
@classmethod
def from_json(cls, json_str: str) -> Self:
"""Create an instance of ExpandAccountGroupOptions from a JSON string"""
return cls(json.loads(json_str))
@classmethod
def _missing_(cls, value):
"""Handle unknown values"""
return cls.UNKNOWN

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -27,7 +26,7 @@ class RoleRequestBody(BaseModel):
RoleRequestBody RoleRequestBody
""" # noqa: E501 """ # noqa: E501
name: Optional[StrictStr] = Field(default=None, description="Name of the role.") name: Optional[StrictStr] = Field(default=None, description="Name of the role.")
permissions: Optional[List[StrictStr]] = Field(default=None, description="Contains list of test permission IDs (get `permissionId` from `/permissions` endpoint)") permissions: Optional[List[StrictStr]] = Field(default=None, description="Contains list of test permission IDs (get `permissionId` from `/permissions` operation)")
__properties: ClassVar[List[str]] = ["name", "permissions"] __properties: ClassVar[List[str]] = ["name", "permissions"]
model_config = ConfigDict( model_config = ConfigDict(

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -126,6 +125,7 @@ class TestAccountGroupsApi(unittest.TestCase):
}, },
"accountGroupName" : "Account A", "accountGroupName" : "Account A",
"isDefaultAccountGroup" : true, "isDefaultAccountGroup" : true,
"accountToken" : "6j052y4vfgyuhefghue",
"aid" : "1234", "aid" : "1234",
"users" : [ { "users" : [ {
"uid" : "235", "uid" : "235",
@ -389,6 +389,7 @@ class TestAccountGroupsApi(unittest.TestCase):
}, },
"accountGroupName" : "Account A", "accountGroupName" : "Account A",
"isDefaultAccountGroup" : true, "isDefaultAccountGroup" : true,
"accountToken" : "6j052y4vfgyuhefghue",
"aid" : "1234", "aid" : "1234",
"users" : [ { "users" : [ {
"uid" : "235", "uid" : "235",

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -3,9 +3,8 @@
""" """
Administrative API Administrative API
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management). Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -126,6 +125,82 @@ class TestUsersApi(unittest.TestCase):
"""Test case for delete_user request and response models""" """Test case for delete_user request and response models"""
def test_get_current_user_models_validation(self) -> None:
"""Test case for get_current_user request and response models"""
response_body_json = """
{
"loginAccountGroup" : {
"accountGroupName" : "Account A",
"aid" : "1234"
},
"uid" : "245",
"lastLogin" : "2022-07-17T22:00:54Z",
"allAccountGroupRoles" : [ {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
}, {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
} ],
"_links" : {
"self" : {
"hreflang" : "hreflang",
"templated" : true,
"profile" : "profile",
"name" : "name",
"href" : "https://api.thousandeyes.com/v7/link/to/resource/id",
"type" : "type",
"deprecation" : "deprecation",
"title" : "title"
}
},
"accountGroupRoles" : [ {
"roles" : [ {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
}, {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
} ],
"accountGroup" : {
"accountGroupName" : "Account A",
"aid" : "1234"
}
}, {
"roles" : [ {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
}, {
"roleId" : "35",
"name" : "Organization Admin",
"isBuiltin" : true,
"hasManagementPermissions" : true
} ],
"accountGroup" : {
"accountGroupName" : "Account A",
"aid" : "1234"
}
} ],
"name" : "User X",
"email" : "userx@thousandeyes.com",
"dateRegistered" : "2020-07-17T22:00:54Z"
}"""
response_loaded_json = json.loads(response_body_json)
response_from_json = thousandeyes_sdk.administrative.models.UserDetail.from_json(response_body_json)
assert_constructed_model_matches_example_json(response_from_json, response_loaded_json)
def test_get_user_models_validation(self) -> None: def test_get_user_models_validation(self) -> None:
"""Test case for get_user request and response models""" """Test case for get_user request and response models"""

View File

@ -2,17 +2,20 @@
MANIFEST.in MANIFEST.in
README.md README.md
docs/AccountGroup.md docs/AccountGroup.md
docs/Agent.md
docs/AgentBase.md docs/AgentBase.md
docs/AgentClusterAssignRequest.md docs/AgentClusterAssignRequest.md
docs/AgentClusterUnassignRequest.md docs/AgentClusterUnassignRequest.md
docs/AgentDetails.md docs/AgentDetails.md
docs/AgentDetailsExpand.md docs/AgentDetailsExpand.md
docs/AgentIpv6Policy.md docs/AgentIpv6Policy.md
docs/AgentLabel.md
docs/AgentListExpand.md docs/AgentListExpand.md
docs/AgentNotification.md
docs/AgentProxies.md docs/AgentProxies.md
docs/AgentProxiesApi.md
docs/AgentProxy.md docs/AgentProxy.md
docs/AgentRequest.md docs/AgentRequest.md
docs/AgentResponse.md
docs/AlertEmail.md docs/AlertEmail.md
docs/AlertIntegrationBase.md docs/AlertIntegrationBase.md
docs/AlertIntegrationType.md docs/AlertIntegrationType.md
@ -35,14 +38,11 @@ docs/Error.md
docs/ErrorDetail.md docs/ErrorDetail.md
docs/ErrorDetailCode.md docs/ErrorDetailCode.md
docs/InterfaceIpMapping.md docs/InterfaceIpMapping.md
docs/Labels.md
docs/Link.md docs/Link.md
docs/ListNotificationRulesResponse.md docs/ListNotificationRulesResponse.md
docs/Notification.md
docs/NotificationRule.md docs/NotificationRule.md
docs/NotificationRuleDetail.md docs/NotificationRuleDetail.md
docs/NotificationRules.md docs/NotificationRules.md
docs/ProxiesApi.md
docs/ProxyAuthType.md docs/ProxyAuthType.md
docs/ProxyType.md docs/ProxyType.md
docs/SelfLinks.md docs/SelfLinks.md
@ -60,23 +60,25 @@ pyproject.toml
setup.cfg setup.cfg
src/thousandeyes_sdk/agents/__init__.py src/thousandeyes_sdk/agents/__init__.py
src/thousandeyes_sdk/agents/api/__init__.py src/thousandeyes_sdk/agents/api/__init__.py
src/thousandeyes_sdk/agents/api/agent_proxies_api.py
src/thousandeyes_sdk/agents/api/cloud_and_enterprise_agent_notification_rules_api.py src/thousandeyes_sdk/agents/api/cloud_and_enterprise_agent_notification_rules_api.py
src/thousandeyes_sdk/agents/api/cloud_and_enterprise_agents_api.py src/thousandeyes_sdk/agents/api/cloud_and_enterprise_agents_api.py
src/thousandeyes_sdk/agents/api/enterprise_agent_cluster_api.py src/thousandeyes_sdk/agents/api/enterprise_agent_cluster_api.py
src/thousandeyes_sdk/agents/api/proxies_api.py
src/thousandeyes_sdk/agents/models/__init__.py src/thousandeyes_sdk/agents/models/__init__.py
src/thousandeyes_sdk/agents/models/account_group.py src/thousandeyes_sdk/agents/models/account_group.py
src/thousandeyes_sdk/agents/models/agent.py
src/thousandeyes_sdk/agents/models/agent_base.py src/thousandeyes_sdk/agents/models/agent_base.py
src/thousandeyes_sdk/agents/models/agent_cluster_assign_request.py src/thousandeyes_sdk/agents/models/agent_cluster_assign_request.py
src/thousandeyes_sdk/agents/models/agent_cluster_unassign_request.py src/thousandeyes_sdk/agents/models/agent_cluster_unassign_request.py
src/thousandeyes_sdk/agents/models/agent_details.py src/thousandeyes_sdk/agents/models/agent_details.py
src/thousandeyes_sdk/agents/models/agent_details_expand.py src/thousandeyes_sdk/agents/models/agent_details_expand.py
src/thousandeyes_sdk/agents/models/agent_ipv6_policy.py src/thousandeyes_sdk/agents/models/agent_ipv6_policy.py
src/thousandeyes_sdk/agents/models/agent_label.py
src/thousandeyes_sdk/agents/models/agent_list_expand.py src/thousandeyes_sdk/agents/models/agent_list_expand.py
src/thousandeyes_sdk/agents/models/agent_notification.py
src/thousandeyes_sdk/agents/models/agent_proxies.py src/thousandeyes_sdk/agents/models/agent_proxies.py
src/thousandeyes_sdk/agents/models/agent_proxy.py src/thousandeyes_sdk/agents/models/agent_proxy.py
src/thousandeyes_sdk/agents/models/agent_request.py src/thousandeyes_sdk/agents/models/agent_request.py
src/thousandeyes_sdk/agents/models/agent_response.py
src/thousandeyes_sdk/agents/models/alert_email.py src/thousandeyes_sdk/agents/models/alert_email.py
src/thousandeyes_sdk/agents/models/alert_integration_base.py src/thousandeyes_sdk/agents/models/alert_integration_base.py
src/thousandeyes_sdk/agents/models/alert_integration_type.py src/thousandeyes_sdk/agents/models/alert_integration_type.py
@ -96,10 +98,8 @@ src/thousandeyes_sdk/agents/models/error.py
src/thousandeyes_sdk/agents/models/error_detail.py src/thousandeyes_sdk/agents/models/error_detail.py
src/thousandeyes_sdk/agents/models/error_detail_code.py src/thousandeyes_sdk/agents/models/error_detail_code.py
src/thousandeyes_sdk/agents/models/interface_ip_mapping.py src/thousandeyes_sdk/agents/models/interface_ip_mapping.py
src/thousandeyes_sdk/agents/models/labels.py
src/thousandeyes_sdk/agents/models/link.py src/thousandeyes_sdk/agents/models/link.py
src/thousandeyes_sdk/agents/models/list_notification_rules_response.py src/thousandeyes_sdk/agents/models/list_notification_rules_response.py
src/thousandeyes_sdk/agents/models/notification.py
src/thousandeyes_sdk/agents/models/notification_rule.py src/thousandeyes_sdk/agents/models/notification_rule.py
src/thousandeyes_sdk/agents/models/notification_rule_detail.py src/thousandeyes_sdk/agents/models/notification_rule_detail.py
src/thousandeyes_sdk/agents/models/notification_rules.py src/thousandeyes_sdk/agents/models/notification_rules.py
@ -118,8 +118,8 @@ src/thousandeyes_sdk/agents/models/validation_error.py
src/thousandeyes_sdk/agents/models/validation_error_item.py src/thousandeyes_sdk/agents/models/validation_error_item.py
src/thousandeyes_sdk/agents/py.typed src/thousandeyes_sdk/agents/py.typed
test/__init__.py test/__init__.py
test/test_agent_proxies_api.py
test/test_cloud_and_enterprise_agent_notification_rules_api.py test/test_cloud_and_enterprise_agent_notification_rules_api.py
test/test_cloud_and_enterprise_agents_api.py test/test_cloud_and_enterprise_agents_api.py
test/test_enterprise_agent_cluster_api.py test/test_enterprise_agent_cluster_api.py
test/test_proxies_api.py
test/test_utils.py test/test_utils.py

View File

@ -5,7 +5,7 @@ Manage all agents available to your account in ThousandEyes, including both Clou
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.8 - API version: 7.0.20
- Generator version: 7.6.0 - Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
@ -57,10 +57,10 @@ import thousandeyes_sdk.agents
from thousandeyes_sdk.core.exceptions import ApiException from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -77,51 +77,52 @@ configuration = thousandeyes_sdk.core.Configuration(
# Enter a context with an instance of the API client # Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client: with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = thousandeyes_sdk.agents.CloudAndEnterpriseAgentNotificationRulesApi(api_client) api_instance = thousandeyes_sdk.agents.AgentProxiesApi(api_client)
notification_rule_id = '281474976710706' # str | Unique ID for the agent notification rule.
aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional) aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
try: try:
# Retrieve agent notification rule # List agent proxies
api_response = api_instance.get_agents_notification_rule(notification_rule_id, aid=aid) api_response = api_instance.get_agents_proxies(aid=aid)
print("The response of CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule:\n") print("The response of AgentProxiesApi->get_agents_proxies:\n")
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule: %s\n" % e) print("Exception when calling AgentProxiesApi->get_agents_proxies: %s\n" % e)
``` ```
## Documentation for API Endpoints ## Documentation for API Endpoints
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Class | Method | HTTP request | Description Class | Method | HTTP request | Description
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
*CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rule**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rule) | **GET** /v7/agents/notification-rules/{notificationRuleId} | Retrieve agent notification rule *AgentProxiesApi* | [**get_agents_proxies**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentProxiesApi.md#get_agents_proxies) | **GET** /agents/proxies | List agent proxies
*CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rules**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rules) | **GET** /v7/agents/notification-rules | List agent notification rules *CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rule**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rule) | **GET** /agents/notification-rules/{notificationRuleId} | Retrieve agent notification rule
*CloudAndEnterpriseAgentsApi* | [**delete_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#delete_agent) | **DELETE** /v7/agents/{agentId} | Delete Enterprise Agent *CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rules**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rules) | **GET** /agents/notification-rules | List agent notification rules
*CloudAndEnterpriseAgentsApi* | [**get_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#get_agent) | **GET** /v7/agents/{agentId} | Retrieve Cloud and Enterprise Agent *CloudAndEnterpriseAgentsApi* | [**delete_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#delete_agent) | **DELETE** /agents/{agentId} | Delete Enterprise Agent
*CloudAndEnterpriseAgentsApi* | [**get_agents**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#get_agents) | **GET** /v7/agents | List Cloud and Enterprise Agents *CloudAndEnterpriseAgentsApi* | [**get_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#get_agent) | **GET** /agents/{agentId} | Retrieve Cloud and Enterprise Agent
*CloudAndEnterpriseAgentsApi* | [**update_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#update_agent) | **PUT** /v7/agents/{agentId} | Update Enterprise Agent *CloudAndEnterpriseAgentsApi* | [**get_agents**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#get_agents) | **GET** /agents | List Cloud and Enterprise Agents
*EnterpriseAgentClusterApi* | [**assign_agent_to_cluster**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/EnterpriseAgentClusterApi.md#assign_agent_to_cluster) | **POST** /v7/agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster *CloudAndEnterpriseAgentsApi* | [**update_agent**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/CloudAndEnterpriseAgentsApi.md#update_agent) | **PUT** /agents/{agentId} | Update Enterprise Agent
*EnterpriseAgentClusterApi* | [**unassign_agent_from_cluster**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/EnterpriseAgentClusterApi.md#unassign_agent_from_cluster) | **POST** /v7/agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster *EnterpriseAgentClusterApi* | [**assign_agent_to_cluster**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/EnterpriseAgentClusterApi.md#assign_agent_to_cluster) | **POST** /agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster
*ProxiesApi* | [**get_agents_proxies**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ProxiesApi.md#get_agents_proxies) | **GET** /v7/agents/proxies | List agent proxies *EnterpriseAgentClusterApi* | [**unassign_agent_from_cluster**](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/EnterpriseAgentClusterApi.md#unassign_agent_from_cluster) | **POST** /agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster
## Documentation For Models ## Documentation For Models
- [AccountGroup](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AccountGroup.md) - [AccountGroup](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AccountGroup.md)
- [Agent](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/Agent.md)
- [AgentBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentBase.md) - [AgentBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentBase.md)
- [AgentClusterAssignRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentClusterAssignRequest.md) - [AgentClusterAssignRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentClusterAssignRequest.md)
- [AgentClusterUnassignRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentClusterUnassignRequest.md) - [AgentClusterUnassignRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentClusterUnassignRequest.md)
- [AgentDetails](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentDetails.md) - [AgentDetails](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentDetails.md)
- [AgentDetailsExpand](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentDetailsExpand.md) - [AgentDetailsExpand](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentDetailsExpand.md)
- [AgentIpv6Policy](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentIpv6Policy.md) - [AgentIpv6Policy](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentIpv6Policy.md)
- [AgentLabel](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentLabel.md)
- [AgentListExpand](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentListExpand.md) - [AgentListExpand](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentListExpand.md)
- [AgentNotification](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentNotification.md)
- [AgentProxies](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentProxies.md) - [AgentProxies](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentProxies.md)
- [AgentProxy](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentProxy.md) - [AgentProxy](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentProxy.md)
- [AgentRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentRequest.md) - [AgentRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentRequest.md)
- [AgentResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AgentResponse.md)
- [AlertEmail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertEmail.md) - [AlertEmail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertEmail.md)
- [AlertIntegrationBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertIntegrationBase.md) - [AlertIntegrationBase](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertIntegrationBase.md)
- [AlertIntegrationType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertIntegrationType.md) - [AlertIntegrationType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/AlertIntegrationType.md)
@ -141,10 +142,8 @@ Class | Method | HTTP request | Description
- [ErrorDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ErrorDetail.md) - [ErrorDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ErrorDetail.md)
- [ErrorDetailCode](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ErrorDetailCode.md) - [ErrorDetailCode](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ErrorDetailCode.md)
- [InterfaceIpMapping](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/InterfaceIpMapping.md) - [InterfaceIpMapping](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/InterfaceIpMapping.md)
- [Labels](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/Labels.md)
- [Link](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/Link.md) - [Link](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/Link.md)
- [ListNotificationRulesResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ListNotificationRulesResponse.md) - [ListNotificationRulesResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/ListNotificationRulesResponse.md)
- [Notification](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/Notification.md)
- [NotificationRule](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRule.md) - [NotificationRule](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRule.md)
- [NotificationRuleDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRuleDetail.md) - [NotificationRuleDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRuleDetail.md)
- [NotificationRules](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRules.md) - [NotificationRules](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-agents/docs/NotificationRules.md)

View File

@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**agents** | **List[str]** | Contains list of agent IDs (get `agentId` from `/agents` endpoint) | [optional] **agents** | **List[str]** | Contains list of agent IDs (get `agentId` from `/agents` operation) | [optional]
## Example ## Example

View File

@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**members** | **List[str]** | Contains list of member IDs. (get `memberId` from `/agents/{agentId}` endpoint) | [optional] **members** | **List[str]** | Contains list of member IDs. (get `memberId` from `/agents/{agentId}` operation) | [optional]
## Example ## Example

View File

@ -17,7 +17,7 @@ Name | Type | Description | Notes
**verify_ssl_certificates** | **bool** | Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests. | [optional] [readonly] **verify_ssl_certificates** | **bool** | Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests. | [optional] [readonly]
**agent_type** | **str** | Enterprise Cluster agent type. | **agent_type** | **str** | Enterprise Cluster agent type. |
**tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional] **tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional]
**labels** | [**List[Labels]**](Labels.md) | List of labels. See `/labels` for more information. | [optional] [readonly] **labels** | [**List[AgentLabel]**](AgentLabel.md) | List of labels. See `/labels` for more information. | [optional] [readonly]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]
**cluster_members** | [**List[ClusterMember]**](ClusterMember.md) | If an enterprise agent is clustered, detailed information about each cluster member will be shown as array entries in the clusterMembers field. This field is not shown for Enterprise Agents in standalone mode, or for Cloud Agents. | [optional] [readonly] **cluster_members** | [**List[ClusterMember]**](ClusterMember.md) | If an enterprise agent is clustered, detailed information about each cluster member will be shown as array entries in the clusterMembers field. This field is not shown for Enterprise Agents in standalone mode, or for Cloud Agents. | [optional] [readonly]
**utilization** | **int** | Shows overall utilization percentage (online Enterprise Agents and Enterprise Clusters only). | [optional] [readonly] **utilization** | **int** | Shows overall utilization percentage (online Enterprise Agents and Enterprise Clusters only). | [optional] [readonly]

View File

@ -1,4 +1,4 @@
# Labels # AgentLabel
## Properties ## Properties
@ -11,19 +11,19 @@ Name | Type | Description | Notes
## Example ## Example
```python ```python
from thousandeyes_sdk.agents.models.labels import Labels from thousandeyes_sdk.agents.models.agent_label import AgentLabel
# TODO update the JSON string below # TODO update the JSON string below
json = "{}" json = "{}"
# create an instance of Labels from a JSON string # create an instance of AgentLabel from a JSON string
labels_instance = Labels.from_json(json) agent_label_instance = AgentLabel.from_json(json)
# print the JSON string representation of the object # print the JSON string representation of the object
print(Labels.to_json()) print(AgentLabel.to_json())
# convert the object into a dict # convert the object into a dict
labels_dict = labels_instance.to_dict() agent_label_dict = agent_label_instance.to_dict()
# create an instance of Labels from a dict # create an instance of AgentLabel from a dict
labels_from_dict = Labels.from_dict(labels_dict) agent_label_from_dict = AgentLabel.from_dict(agent_label_dict)
``` ```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,4 +1,4 @@
# Notification # AgentNotification
Alert notification object. Alert notification object.
@ -13,19 +13,19 @@ Name | Type | Description | Notes
## Example ## Example
```python ```python
from thousandeyes_sdk.agents.models.notification import Notification from thousandeyes_sdk.agents.models.agent_notification import AgentNotification
# TODO update the JSON string below # TODO update the JSON string below
json = "{}" json = "{}"
# create an instance of Notification from a JSON string # create an instance of AgentNotification from a JSON string
notification_instance = Notification.from_json(json) agent_notification_instance = AgentNotification.from_json(json)
# print the JSON string representation of the object # print the JSON string representation of the object
print(Notification.to_json()) print(AgentNotification.to_json())
# convert the object into a dict # convert the object into a dict
notification_dict = notification_instance.to_dict() agent_notification_dict = agent_notification_instance.to_dict()
# create an instance of Notification from a dict # create an instance of AgentNotification from a dict
notification_from_dict = Notification.from_dict(notification_dict) agent_notification_from_dict = AgentNotification.from_dict(agent_notification_dict)
``` ```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,10 +1,10 @@
# thousandeyes_sdk.agents.ProxiesApi # thousandeyes_sdk.agents.AgentProxiesApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**get_agents_proxies**](ProxiesApi.md#get_agents_proxies) | **GET** /v7/agents/proxies | List agent proxies [**get_agents_proxies**](AgentProxiesApi.md#get_agents_proxies) | **GET** /agents/proxies | List agent proxies
# **get_agents_proxies** # **get_agents_proxies**
@ -24,10 +24,10 @@ from thousandeyes_sdk.agents.models.agent_proxies import AgentProxies
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -43,16 +43,16 @@ configuration = thousandeyes_sdk.core.Configuration(
# Enter a context with an instance of the API client # Enter a context with an instance of the API client
with thousandeyes_sdk.agents.ApiClient(configuration) as api_client: with thousandeyes_sdk.agents.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = thousandeyes_sdk.agents.ProxiesApi(api_client) api_instance = thousandeyes_sdk.agents.AgentProxiesApi(api_client)
aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional) aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
try: try:
# List agent proxies # List agent proxies
api_response = api_instance.get_agents_proxies(aid=aid) api_response = api_instance.get_agents_proxies(aid=aid)
print("The response of ProxiesApi->get_agents_proxies:\n") print("The response of AgentProxiesApi->get_agents_proxies:\n")
pprint(api_response) pprint(api_response)
except Exception as e: except Exception as e:
print("Exception when calling ProxiesApi->get_agents_proxies: %s\n" % e) print("Exception when calling AgentProxiesApi->get_agents_proxies: %s\n" % e)
``` ```

View File

@ -1,4 +1,4 @@
# Agent # AgentResponse
## Properties ## Properties
@ -20,19 +20,19 @@ Name | Type | Description | Notes
## Example ## Example
```python ```python
from thousandeyes_sdk.agents.models.agent import Agent from thousandeyes_sdk.agents.models.agent_response import AgentResponse
# TODO update the JSON string below # TODO update the JSON string below
json = "{}" json = "{}"
# create an instance of Agent from a JSON string # create an instance of AgentResponse from a JSON string
agent_instance = Agent.from_json(json) agent_response_instance = AgentResponse.from_json(json)
# print the JSON string representation of the object # print the JSON string representation of the object
print(Agent.to_json()) print(AgentResponse.to_json())
# convert the object into a dict # convert the object into a dict
agent_dict = agent_instance.to_dict() agent_response_dict = agent_response_instance.to_dict()
# create an instance of Agent from a dict # create an instance of AgentResponse from a dict
agent_from_dict = Agent.from_dict(agent_dict) agent_response_from_dict = AgentResponse.from_dict(agent_response_dict)
``` ```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -17,7 +17,7 @@ Name | Type | Description | Notes
**verify_ssl_certificates** | **bool** | Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests. | [optional] [readonly] **verify_ssl_certificates** | **bool** | Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests. | [optional] [readonly]
**agent_type** | **str** | Cloud agent type. | **agent_type** | **str** | Cloud agent type. |
**tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional] **tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional]
**labels** | [**List[Labels]**](Labels.md) | List of labels - see `/labels` for more information. | [optional] [readonly] **labels** | [**List[AgentLabel]**](AgentLabel.md) | List of labels - see `/labels` for more information. | [optional] [readonly]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]
## Example ## Example

View File

@ -1,11 +1,11 @@
# thousandeyes_sdk.agents.CloudAndEnterpriseAgentNotificationRulesApi # thousandeyes_sdk.agents.CloudAndEnterpriseAgentNotificationRulesApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**get_agents_notification_rule**](CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rule) | **GET** /v7/agents/notification-rules/{notificationRuleId} | Retrieve agent notification rule [**get_agents_notification_rule**](CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rule) | **GET** /agents/notification-rules/{notificationRuleId} | Retrieve agent notification rule
[**get_agents_notification_rules**](CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rules) | **GET** /v7/agents/notification-rules | List agent notification rules [**get_agents_notification_rules**](CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rules) | **GET** /agents/notification-rules | List agent notification rules
# **get_agents_notification_rule** # **get_agents_notification_rule**
@ -25,10 +25,10 @@ from thousandeyes_sdk.agents.models.notification_rule_detail import Notification
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -112,10 +112,10 @@ from thousandeyes_sdk.agents.models.list_notification_rules_response import List
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -1,13 +1,13 @@
# thousandeyes_sdk.agents.CloudAndEnterpriseAgentsApi # thousandeyes_sdk.agents.CloudAndEnterpriseAgentsApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**delete_agent**](CloudAndEnterpriseAgentsApi.md#delete_agent) | **DELETE** /v7/agents/{agentId} | Delete Enterprise Agent [**delete_agent**](CloudAndEnterpriseAgentsApi.md#delete_agent) | **DELETE** /agents/{agentId} | Delete Enterprise Agent
[**get_agent**](CloudAndEnterpriseAgentsApi.md#get_agent) | **GET** /v7/agents/{agentId} | Retrieve Cloud and Enterprise Agent [**get_agent**](CloudAndEnterpriseAgentsApi.md#get_agent) | **GET** /agents/{agentId} | Retrieve Cloud and Enterprise Agent
[**get_agents**](CloudAndEnterpriseAgentsApi.md#get_agents) | **GET** /v7/agents | List Cloud and Enterprise Agents [**get_agents**](CloudAndEnterpriseAgentsApi.md#get_agents) | **GET** /agents | List Cloud and Enterprise Agents
[**update_agent**](CloudAndEnterpriseAgentsApi.md#update_agent) | **PUT** /v7/agents/{agentId} | Update Enterprise Agent [**update_agent**](CloudAndEnterpriseAgentsApi.md#update_agent) | **PUT** /agents/{agentId} | Update Enterprise Agent
# **delete_agent** # **delete_agent**
@ -26,10 +26,10 @@ import thousandeyes_sdk.agents
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -99,7 +99,7 @@ void (empty response body)
Retrieve Cloud and Enterprise Agent Retrieve Cloud and Enterprise Agent
Returns details for an agent, including assigned tests. For Enterprise Agents, this endpoint returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details. Returns details for an agent, including assigned tests. For Enterprise Agents, this operation returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details.
### Example ### Example
@ -112,10 +112,10 @@ from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpa
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -189,7 +189,7 @@ Name | Type | Description | Notes
List Cloud and Enterprise Agents List Cloud and Enterprise Agents
Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this endpoint returns the agents public and private IP addresses, as well as the public network where the agent is located. Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this operation returns the agents public and private IP addresses, as well as the public network where the agent is located.
### Example ### Example
@ -203,10 +203,10 @@ from thousandeyes_sdk.agents.models.cloud_enterprise_agents import CloudEnterpri
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -280,7 +280,7 @@ Name | Type | Description | Notes
Update Enterprise Agent Update Enterprise Agent
Updates details for an Enterprise Agent. This endpoint can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters. Updates details for an Enterprise Agent. This operation can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters.
### Example ### Example
@ -294,10 +294,10 @@ from thousandeyes_sdk.agents.models.agent_request import AgentRequest
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -1,11 +1,11 @@
# thousandeyes_sdk.agents.EnterpriseAgentClusterApi # thousandeyes_sdk.agents.EnterpriseAgentClusterApi
All URIs are relative to *https://api.thousandeyes.com* All URIs are relative to *https://api.thousandeyes.com/v7*
Method | HTTP request | Description Method | HTTP request | Description
------------- | ------------- | ------------- ------------- | ------------- | -------------
[**assign_agent_to_cluster**](EnterpriseAgentClusterApi.md#assign_agent_to_cluster) | **POST** /v7/agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster [**assign_agent_to_cluster**](EnterpriseAgentClusterApi.md#assign_agent_to_cluster) | **POST** /agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster
[**unassign_agent_from_cluster**](EnterpriseAgentClusterApi.md#unassign_agent_from_cluster) | **POST** /v7/agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster [**unassign_agent_from_cluster**](EnterpriseAgentClusterApi.md#unassign_agent_from_cluster) | **POST** /agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster
# **assign_agent_to_cluster** # **assign_agent_to_cluster**
@ -13,7 +13,7 @@ Method | HTTP request | Description
Add member to Enterprise Agent cluster Add member to Enterprise Agent cluster
Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This endpoint requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```` Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This operation requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ````
### Example ### Example
@ -27,10 +27,10 @@ from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpa
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters
@ -107,7 +107,7 @@ Name | Type | Description | Notes
Remove member from Enterprise Agent cluster Remove member from Enterprise Agent cluster
Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This endpoint can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This endpoint is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This operation can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This operation is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```
### Example ### Example
@ -121,10 +121,10 @@ from thousandeyes_sdk.agents.models.cloud_enterprise_agents import CloudEnterpri
from thousandeyes_sdk.agents.rest import ApiException from thousandeyes_sdk.agents.rest import ApiException
from pprint import pprint from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com # Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters. # See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration( configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com" host = "https://api.thousandeyes.com/v7"
) )
# The client must configure the authentication and authorization parameters # The client must configure the authentication and authorization parameters

View File

@ -30,7 +30,7 @@ Name | Type | Description | Notes
**interface_ip_mappings** | [**List[InterfaceIpMapping]**](InterfaceIpMapping.md) | | [optional] [readonly] **interface_ip_mappings** | [**List[InterfaceIpMapping]**](InterfaceIpMapping.md) | | [optional] [readonly]
**tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional] **tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional]
**notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional] **notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional]
**labels** | [**List[Labels]**](Labels.md) | List of labels. See `/labels` for more information. | [optional] [readonly] **labels** | [**List[AgentLabel]**](AgentLabel.md) | List of labels. See `/labels` for more information. | [optional] [readonly]
**agent_type** | **str** | Enterprise Cluster agent type. | **agent_type** | **str** | Enterprise Cluster agent type. |
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]

View File

@ -30,7 +30,7 @@ Name | Type | Description | Notes
**interface_ip_mappings** | [**List[InterfaceIpMapping]**](InterfaceIpMapping.md) | | [optional] [readonly] **interface_ip_mappings** | [**List[InterfaceIpMapping]**](InterfaceIpMapping.md) | | [optional] [readonly]
**tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional] **tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional]
**notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional] **notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional]
**labels** | [**List[Labels]**](Labels.md) | List of labels. See `/labels` for more information. | [optional] [readonly] **labels** | [**List[AgentLabel]**](AgentLabel.md) | List of labels. See `/labels` for more information. | [optional] [readonly]
**agent_type** | **str** | Enterprise agent type. | **agent_type** | **str** | Enterprise agent type. |
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional] **tests** | [**List[SimpleTest]**](SimpleTest.md) | List of tests. See `/tests` for more information. | [optional]
**notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional] **notification_rules** | [**List[NotificationRules]**](NotificationRules.md) | List of notification rule objects configured on agent | [optional]
**labels** | [**List[Labels]**](Labels.md) | List of labels. See `/labels` for more information. | [optional] [readonly] **labels** | [**List[AgentLabel]**](AgentLabel.md) | List of labels. See `/labels` for more information. | [optional] [readonly]
## Example ## Example

View File

@ -10,8 +10,8 @@ Name | Type | Description | Notes
**expression** | **str** | Expression of agent notification rule | [optional] **expression** | **str** | Expression of agent notification rule | [optional]
**notify_on_clear** | **bool** | Send notification when notification clears | [optional] **notify_on_clear** | **bool** | Send notification when notification clears | [optional]
**is_default** | **bool** | Agent notification rule will be automatically included on all new Enterprise Agents. | [optional] **is_default** | **bool** | Agent notification rule will be automatically included on all new Enterprise Agents. | [optional]
**notifications** | [**Notification**](Notification.md) | | [optional] **notifications** | [**AgentNotification**](AgentNotification.md) | | [optional]
**agents** | [**List[Agent]**](Agent.md) | | [optional] **agents** | [**List[AgentResponse]**](AgentResponse.md) | | [optional]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional] **links** | [**SelfLinks**](SelfLinks.md) | | [optional]
## Example ## Example

View File

@ -9,9 +9,9 @@ description = "ThousandEyes SDK Agents API"
license = { file = "LICENSE" } license = { file = "LICENSE" }
requires-python = ">= 3.8" requires-python = ">= 3.8"
dependencies = [ dependencies = [
"urllib3 >= 1.25.3", "urllib3 >= 2.0.0",
"python-dateutil >=2.8.2", "python-dateutil >=2.8.2",
"pydantic >=2", "pydantic >=2.1.0",
"typing-extensions >=4.7.1", "typing-extensions >=4.7.1",
"thousandeyes-sdk-core", "thousandeyes-sdk-core",
] ]

View File

@ -7,7 +7,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -15,25 +14,27 @@
# import apis into sdk package # import apis into sdk package
from thousandeyes_sdk.agents.api.agent_proxies_api import AgentProxiesApi
from thousandeyes_sdk.agents.api.cloud_and_enterprise_agent_notification_rules_api import CloudAndEnterpriseAgentNotificationRulesApi from thousandeyes_sdk.agents.api.cloud_and_enterprise_agent_notification_rules_api import CloudAndEnterpriseAgentNotificationRulesApi
from thousandeyes_sdk.agents.api.cloud_and_enterprise_agents_api import CloudAndEnterpriseAgentsApi from thousandeyes_sdk.agents.api.cloud_and_enterprise_agents_api import CloudAndEnterpriseAgentsApi
from thousandeyes_sdk.agents.api.enterprise_agent_cluster_api import EnterpriseAgentClusterApi from thousandeyes_sdk.agents.api.enterprise_agent_cluster_api import EnterpriseAgentClusterApi
from thousandeyes_sdk.agents.api.proxies_api import ProxiesApi
# import models into sdk package # import models into sdk package
from thousandeyes_sdk.agents.models.account_group import AccountGroup from thousandeyes_sdk.agents.models.account_group import AccountGroup
from thousandeyes_sdk.agents.models.agent import Agent
from thousandeyes_sdk.agents.models.agent_base import AgentBase from thousandeyes_sdk.agents.models.agent_base import AgentBase
from thousandeyes_sdk.agents.models.agent_cluster_assign_request import AgentClusterAssignRequest from thousandeyes_sdk.agents.models.agent_cluster_assign_request import AgentClusterAssignRequest
from thousandeyes_sdk.agents.models.agent_cluster_unassign_request import AgentClusterUnassignRequest from thousandeyes_sdk.agents.models.agent_cluster_unassign_request import AgentClusterUnassignRequest
from thousandeyes_sdk.agents.models.agent_details import AgentDetails from thousandeyes_sdk.agents.models.agent_details import AgentDetails
from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpand from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpand
from thousandeyes_sdk.agents.models.agent_ipv6_policy import AgentIpv6Policy from thousandeyes_sdk.agents.models.agent_ipv6_policy import AgentIpv6Policy
from thousandeyes_sdk.agents.models.agent_label import AgentLabel
from thousandeyes_sdk.agents.models.agent_list_expand import AgentListExpand from thousandeyes_sdk.agents.models.agent_list_expand import AgentListExpand
from thousandeyes_sdk.agents.models.agent_notification import AgentNotification
from thousandeyes_sdk.agents.models.agent_proxies import AgentProxies from thousandeyes_sdk.agents.models.agent_proxies import AgentProxies
from thousandeyes_sdk.agents.models.agent_proxy import AgentProxy from thousandeyes_sdk.agents.models.agent_proxy import AgentProxy
from thousandeyes_sdk.agents.models.agent_request import AgentRequest from thousandeyes_sdk.agents.models.agent_request import AgentRequest
from thousandeyes_sdk.agents.models.agent_response import AgentResponse
from thousandeyes_sdk.agents.models.alert_email import AlertEmail from thousandeyes_sdk.agents.models.alert_email import AlertEmail
from thousandeyes_sdk.agents.models.alert_integration_base import AlertIntegrationBase from thousandeyes_sdk.agents.models.alert_integration_base import AlertIntegrationBase
from thousandeyes_sdk.agents.models.alert_integration_type import AlertIntegrationType from thousandeyes_sdk.agents.models.alert_integration_type import AlertIntegrationType
@ -53,10 +54,8 @@ from thousandeyes_sdk.agents.models.error import Error
from thousandeyes_sdk.agents.models.error_detail import ErrorDetail from thousandeyes_sdk.agents.models.error_detail import ErrorDetail
from thousandeyes_sdk.agents.models.error_detail_code import ErrorDetailCode from thousandeyes_sdk.agents.models.error_detail_code import ErrorDetailCode
from thousandeyes_sdk.agents.models.interface_ip_mapping import InterfaceIpMapping from thousandeyes_sdk.agents.models.interface_ip_mapping import InterfaceIpMapping
from thousandeyes_sdk.agents.models.labels import Labels
from thousandeyes_sdk.agents.models.link import Link from thousandeyes_sdk.agents.models.link import Link
from thousandeyes_sdk.agents.models.list_notification_rules_response import ListNotificationRulesResponse from thousandeyes_sdk.agents.models.list_notification_rules_response import ListNotificationRulesResponse
from thousandeyes_sdk.agents.models.notification import Notification
from thousandeyes_sdk.agents.models.notification_rule import NotificationRule from thousandeyes_sdk.agents.models.notification_rule import NotificationRule
from thousandeyes_sdk.agents.models.notification_rule_detail import NotificationRuleDetail from thousandeyes_sdk.agents.models.notification_rule_detail import NotificationRuleDetail
from thousandeyes_sdk.agents.models.notification_rules import NotificationRules from thousandeyes_sdk.agents.models.notification_rules import NotificationRules

View File

@ -1,8 +1,8 @@
# flake8: noqa # flake8: noqa
# import apis into api package # import apis into api package
from thousandeyes_sdk.agents.api.agent_proxies_api import AgentProxiesApi
from thousandeyes_sdk.agents.api.cloud_and_enterprise_agent_notification_rules_api import CloudAndEnterpriseAgentNotificationRulesApi from thousandeyes_sdk.agents.api.cloud_and_enterprise_agent_notification_rules_api import CloudAndEnterpriseAgentNotificationRulesApi
from thousandeyes_sdk.agents.api.cloud_and_enterprise_agents_api import CloudAndEnterpriseAgentsApi from thousandeyes_sdk.agents.api.cloud_and_enterprise_agents_api import CloudAndEnterpriseAgentsApi
from thousandeyes_sdk.agents.api.enterprise_agent_cluster_api import EnterpriseAgentClusterApi from thousandeyes_sdk.agents.api.enterprise_agent_cluster_api import EnterpriseAgentClusterApi
from thousandeyes_sdk.agents.api.proxies_api import ProxiesApi

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -29,7 +28,7 @@ from thousandeyes_sdk.core.api_response import ApiResponse
from thousandeyes_sdk.core.rest import RESTResponseType from thousandeyes_sdk.core.rest import RESTResponseType
class ProxiesApi: class AgentProxiesApi:
"""NOTE: This class is auto generated by OpenAPI Generator """NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
@ -309,7 +308,7 @@ class ProxiesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/agents/proxies', resource_path='/agents/proxies',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -325,7 +324,7 @@ class CloudAndEnterpriseAgentNotificationRulesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/agents/notification-rules/{notificationRuleId}', resource_path='/agents/notification-rules/{notificationRuleId}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -607,7 +606,7 @@ class CloudAndEnterpriseAgentNotificationRulesApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/agents/notification-rules', resource_path='/agents/notification-rules',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -328,7 +327,7 @@ class CloudAndEnterpriseAgentsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='DELETE', method='DELETE',
resource_path='/v7/agents/{agentId}', resource_path='/agents/{agentId}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -365,7 +364,7 @@ class CloudAndEnterpriseAgentsApi:
) -> AgentDetails: ) -> AgentDetails:
"""Retrieve Cloud and Enterprise Agent """Retrieve Cloud and Enterprise Agent
Returns details for an agent, including assigned tests. For Enterprise Agents, this endpoint returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details. Returns details for an agent, including assigned tests. For Enterprise Agents, this operation returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -447,7 +446,7 @@ class CloudAndEnterpriseAgentsApi:
) -> ApiResponse[AgentDetails]: ) -> ApiResponse[AgentDetails]:
"""Retrieve Cloud and Enterprise Agent """Retrieve Cloud and Enterprise Agent
Returns details for an agent, including assigned tests. For Enterprise Agents, this endpoint returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details. Returns details for an agent, including assigned tests. For Enterprise Agents, this operation returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -529,7 +528,7 @@ class CloudAndEnterpriseAgentsApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Retrieve Cloud and Enterprise Agent """Retrieve Cloud and Enterprise Agent
Returns details for an agent, including assigned tests. For Enterprise Agents, this endpoint returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details. Returns details for an agent, including assigned tests. For Enterprise Agents, this operation returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -643,7 +642,7 @@ class CloudAndEnterpriseAgentsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/agents/{agentId}', resource_path='/agents/{agentId}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -680,7 +679,7 @@ class CloudAndEnterpriseAgentsApi:
) -> CloudEnterpriseAgents: ) -> CloudEnterpriseAgents:
"""List Cloud and Enterprise Agents """List Cloud and Enterprise Agents
Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this endpoint returns the agents public and private IP addresses, as well as the public network where the agent is located. Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this operation returns the agents public and private IP addresses, as well as the public network where the agent is located.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -762,7 +761,7 @@ class CloudAndEnterpriseAgentsApi:
) -> ApiResponse[CloudEnterpriseAgents]: ) -> ApiResponse[CloudEnterpriseAgents]:
"""List Cloud and Enterprise Agents """List Cloud and Enterprise Agents
Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this endpoint returns the agents public and private IP addresses, as well as the public network where the agent is located. Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this operation returns the agents public and private IP addresses, as well as the public network where the agent is located.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -844,7 +843,7 @@ class CloudAndEnterpriseAgentsApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""List Cloud and Enterprise Agents """List Cloud and Enterprise Agents
Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this endpoint returns the agents public and private IP addresses, as well as the public network where the agent is located. Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents. If an agent is an Enterprise Agent, this operation returns the agents public and private IP addresses, as well as the public network where the agent is located.
:param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. :param aid: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
:type aid: str :type aid: str
@ -961,7 +960,7 @@ class CloudAndEnterpriseAgentsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='GET', method='GET',
resource_path='/v7/agents', resource_path='/agents',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -999,7 +998,7 @@ class CloudAndEnterpriseAgentsApi:
) -> AgentDetails: ) -> AgentDetails:
"""Update Enterprise Agent """Update Enterprise Agent
Updates details for an Enterprise Agent. This endpoint can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters. Updates details for an Enterprise Agent. This operation can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -1086,7 +1085,7 @@ class CloudAndEnterpriseAgentsApi:
) -> ApiResponse[AgentDetails]: ) -> ApiResponse[AgentDetails]:
"""Update Enterprise Agent """Update Enterprise Agent
Updates details for an Enterprise Agent. This endpoint can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters. Updates details for an Enterprise Agent. This operation can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -1173,7 +1172,7 @@ class CloudAndEnterpriseAgentsApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Update Enterprise Agent """Update Enterprise Agent
Updates details for an Enterprise Agent. This endpoint can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters. Updates details for an Enterprise Agent. This operation can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents. Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed. Users can update the following fields: * `agentName`: String representation of an agent. No two agents can have the same display name. * `enabled`: Boolean representation of agent state. * `accountGroups`: An array of account group ids. See `v7/account-groups` to pull a list of account IDs. * `tests`: An array of test Is. See `v7/tests` to retrieve a list tests available in the current account context. * `ipv6Policy`: Enum representation of the IP version policy. * `keepBrowserCache`: Boolean representation of the Keep browser cache state. * `targetForTests`: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test. * `localResolutionPrefixes`: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as `10.1.1.0/24`. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters.
:param agent_id: Unique ID for the agent. (required) :param agent_id: Unique ID for the agent. (required)
:type agent_id: str :type agent_id: str
@ -1307,7 +1306,7 @@ class CloudAndEnterpriseAgentsApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='PUT', method='PUT',
resource_path='/v7/agents/{agentId}', resource_path='/agents/{agentId}',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -69,7 +68,7 @@ class EnterpriseAgentClusterApi:
) -> AgentDetails: ) -> AgentDetails:
"""Add member to Enterprise Agent cluster """Add member to Enterprise Agent cluster
Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This endpoint requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```` Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This operation requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ````
:param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required)
:type agent_id: str :type agent_id: str
@ -156,7 +155,7 @@ class EnterpriseAgentClusterApi:
) -> ApiResponse[AgentDetails]: ) -> ApiResponse[AgentDetails]:
"""Add member to Enterprise Agent cluster """Add member to Enterprise Agent cluster
Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This endpoint requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```` Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This operation requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ````
:param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required)
:type agent_id: str :type agent_id: str
@ -243,7 +242,7 @@ class EnterpriseAgentClusterApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Add member to Enterprise Agent cluster """Add member to Enterprise Agent cluster
Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This endpoint requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```` Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster. The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the `?expand=cluster-member` parameter. This operation requires users to have the `Edit agents in account group` permission. Upon successful cluster creation, the response includes: * Information about the new cluster in the response body. * Each cluster member receives a unique `memberId` within the cluster. * The `memberId` value is not linked to the original `agentId` used in the request URL or POST body. * The cluster name is based on the agent whose `agentId` is present in the request URL. **Example - converting a single agent** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H \"Authorization: Bearer $Bearer_token\" ```` **Example - converting multiple agents** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \\ '{\"agents\":[ \"2277\", \"1234\" ]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ````
:param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to add new agents to. (required)
:type agent_id: str :type agent_id: str
@ -377,7 +376,7 @@ class EnterpriseAgentClusterApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='POST', method='POST',
resource_path='/v7/agents/{agentId}/cluster/assign', resource_path='/agents/{agentId}/cluster/assign',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,
@ -415,7 +414,7 @@ class EnterpriseAgentClusterApi:
) -> CloudEnterpriseAgents: ) -> CloudEnterpriseAgents:
"""Remove member from Enterprise Agent cluster """Remove member from Enterprise Agent cluster
Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This endpoint can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This endpoint is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This operation can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This operation is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```
:param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required)
:type agent_id: str :type agent_id: str
@ -502,7 +501,7 @@ class EnterpriseAgentClusterApi:
) -> ApiResponse[CloudEnterpriseAgents]: ) -> ApiResponse[CloudEnterpriseAgents]:
"""Remove member from Enterprise Agent cluster """Remove member from Enterprise Agent cluster
Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This endpoint can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This endpoint is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This operation can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This operation is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```
:param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required)
:type agent_id: str :type agent_id: str
@ -589,7 +588,7 @@ class EnterpriseAgentClusterApi:
) -> RESTResponseType: ) -> RESTResponseType:
"""Remove member from Enterprise Agent cluster """Remove member from Enterprise Agent cluster
Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This endpoint can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This endpoint is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This operation can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted. The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This operation is exclusive to Enterprise Agent clusters and can be accessed only by users with the `Edit agents in account group` permission. On successful completion, the response contains the following information: * The updated cluster information is provided in the response body, unless all members are removed from the cluster. * Information about each removed member, now a standalone agent. * When a non-last member is removed from the cluster, it receives a new `agentId` value. This new `agentId` is different from the `agentId` the agent had before joining the cluster, and it is also unrelated to the `memberId` value the agent had while being a part of the cluster. * If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old clusters `agentId` value. The last `memberId` listed in the POST body inherits the clusters `agentId` value. **Example - removing a single member** ``` curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[\"55974\"]}' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ``` **Example - removing multiple members** ``` curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \\ '{\"members\":[ \"55974\", \"12313\"] }' \\ -H \"content-type:application/json\" \\ -H \"Authorization: Bearer $Bearer_token\" ```
:param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required) :param agent_id: Unique ID for the Enterprise Agent cluster to remove agents from. (required)
:type agent_id: str :type agent_id: str
@ -723,7 +722,7 @@ class EnterpriseAgentClusterApi:
return self.api_client.param_serialize( return self.api_client.param_serialize(
method='POST', method='POST',
resource_path='/v7/agents/{agentId}/cluster/unassign', resource_path='/agents/{agentId}/cluster/unassign',
path_params=_path_params, path_params=_path_params,
query_params=_query_params, query_params=_query_params,
header_params=_header_params, header_params=_header_params,

View File

@ -6,7 +6,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.
@ -15,17 +14,19 @@
# import models into model package # import models into model package
from thousandeyes_sdk.agents.models.account_group import AccountGroup from thousandeyes_sdk.agents.models.account_group import AccountGroup
from thousandeyes_sdk.agents.models.agent import Agent
from thousandeyes_sdk.agents.models.agent_base import AgentBase from thousandeyes_sdk.agents.models.agent_base import AgentBase
from thousandeyes_sdk.agents.models.agent_cluster_assign_request import AgentClusterAssignRequest from thousandeyes_sdk.agents.models.agent_cluster_assign_request import AgentClusterAssignRequest
from thousandeyes_sdk.agents.models.agent_cluster_unassign_request import AgentClusterUnassignRequest from thousandeyes_sdk.agents.models.agent_cluster_unassign_request import AgentClusterUnassignRequest
from thousandeyes_sdk.agents.models.agent_details import AgentDetails from thousandeyes_sdk.agents.models.agent_details import AgentDetails
from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpand from thousandeyes_sdk.agents.models.agent_details_expand import AgentDetailsExpand
from thousandeyes_sdk.agents.models.agent_ipv6_policy import AgentIpv6Policy from thousandeyes_sdk.agents.models.agent_ipv6_policy import AgentIpv6Policy
from thousandeyes_sdk.agents.models.agent_label import AgentLabel
from thousandeyes_sdk.agents.models.agent_list_expand import AgentListExpand from thousandeyes_sdk.agents.models.agent_list_expand import AgentListExpand
from thousandeyes_sdk.agents.models.agent_notification import AgentNotification
from thousandeyes_sdk.agents.models.agent_proxies import AgentProxies from thousandeyes_sdk.agents.models.agent_proxies import AgentProxies
from thousandeyes_sdk.agents.models.agent_proxy import AgentProxy from thousandeyes_sdk.agents.models.agent_proxy import AgentProxy
from thousandeyes_sdk.agents.models.agent_request import AgentRequest from thousandeyes_sdk.agents.models.agent_request import AgentRequest
from thousandeyes_sdk.agents.models.agent_response import AgentResponse
from thousandeyes_sdk.agents.models.alert_email import AlertEmail from thousandeyes_sdk.agents.models.alert_email import AlertEmail
from thousandeyes_sdk.agents.models.alert_integration_base import AlertIntegrationBase from thousandeyes_sdk.agents.models.alert_integration_base import AlertIntegrationBase
from thousandeyes_sdk.agents.models.alert_integration_type import AlertIntegrationType from thousandeyes_sdk.agents.models.alert_integration_type import AlertIntegrationType
@ -45,10 +46,8 @@ from thousandeyes_sdk.agents.models.error import Error
from thousandeyes_sdk.agents.models.error_detail import ErrorDetail from thousandeyes_sdk.agents.models.error_detail import ErrorDetail
from thousandeyes_sdk.agents.models.error_detail_code import ErrorDetailCode from thousandeyes_sdk.agents.models.error_detail_code import ErrorDetailCode
from thousandeyes_sdk.agents.models.interface_ip_mapping import InterfaceIpMapping from thousandeyes_sdk.agents.models.interface_ip_mapping import InterfaceIpMapping
from thousandeyes_sdk.agents.models.labels import Labels
from thousandeyes_sdk.agents.models.link import Link from thousandeyes_sdk.agents.models.link import Link
from thousandeyes_sdk.agents.models.list_notification_rules_response import ListNotificationRulesResponse from thousandeyes_sdk.agents.models.list_notification_rules_response import ListNotificationRulesResponse
from thousandeyes_sdk.agents.models.notification import Notification
from thousandeyes_sdk.agents.models.notification_rule import NotificationRule from thousandeyes_sdk.agents.models.notification_rule import NotificationRule
from thousandeyes_sdk.agents.models.notification_rule_detail import NotificationRuleDetail from thousandeyes_sdk.agents.models.notification_rule_detail import NotificationRuleDetail
from thousandeyes_sdk.agents.models.notification_rules import NotificationRules from thousandeyes_sdk.agents.models.notification_rules import NotificationRules

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

View File

@ -5,7 +5,6 @@
## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents. ## Overview Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
The version of the OpenAPI document: 7.0.8
Generated by OpenAPI Generator (https://openapi-generator.tech) Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually. Do not edit the class manually.

Some files were not shown because too many files have changed in this diff Show More