thousandeyes-sdk-administrative 2.1.0

ThousandEyes SDK Administrative API

thousandeyes-sdk-administrative

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.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.28
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-administrative

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-administrative)

Then import the package:

import thousandeyes_sdk.administrative

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import thousandeyes_sdk.administrative

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.administrative
from thousandeyes_sdk.core.exceptions 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.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.administrative.AccountGroupsApi(api_client)
    account_group_request = thousandeyes_sdk.administrative.AccountGroupRequest() # AccountGroupRequest | 
    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:
        # Create account group
        api_response = api_instance.create_account_group(account_group_request, expand=expand)
        print("The response of AccountGroupsApi->create_account_group:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountGroupsApi->create_account_group: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class	Method	HTTP request	Description
AccountGroupsApi	create_account_group	POST /account-groups	Create account group
AccountGroupsApi	delete_account_group	DELETE /account-groups/{id}	Delete account group
AccountGroupsApi	get_account_group	GET /account-groups/{id}	Retrieve account group
AccountGroupsApi	get_account_groups	GET /account-groups	List account groups
AccountGroupsApi	update_account_group	PUT /account-groups/{id}	Update account group
PermissionsApi	get_permissions	GET /permissions	List assignable permissions
RolesApi	create_role	POST /roles	Create role
RolesApi	delete_role	DELETE /roles/{id}	Delete role
RolesApi	get_role	GET /roles/{id}	Retrieve role
RolesApi	get_roles	GET /roles	List roles
RolesApi	update_role	PUT /roles/{id}	Update role
UserEventsApi	get_user_events	GET /audit-user-events	List activity log events
UsersApi	create_user	POST /users	Create user
UsersApi	delete_user	DELETE /users/{id}	Delete user
UsersApi	get_current_user	GET /users/current	Retrieve current user
UsersApi	get_user	GET /users/{id}	Retrieve user
UsersApi	get_users	GET /users	List users
UsersApi	update_user	PUT /users/{id}	Update user

Documentation For Models

• AccountGroup
• AccountGroupDetail
• AccountGroupInfo
• AccountGroupRequest
• AccountGroupRole
• AccountGroups
• AgentBase
• AgentResponse
• AuditUserEvents
• BaseRole
• CloudEnterpriseAgentType
• ClusterMember
• CreatedAccountGroup
• CreatedUser
• EnterpriseAgent
• EnterpriseAgentData
• EnterpriseAgentIpv6Policy
• EnterpriseAgentState
• Error
• ErrorDetail
• ErrorDetailCode
• ExpandAccountGroupOptions
• ExtendedUser
• InterfaceIpMapping
• Link
• PaginationLinks
• Permission
• Permissions
• Resource
• Role
• RoleDetail
• RoleRequestBody
• Roles
• SelfLinks
• SimpleAgent
• UnauthorizedError
• User
• UserAccountGroup
• UserAccountGroupRole
• UserDetail
• UserEvent
• UserRequest
• Users
• ValidationError
• ValidationErrorItem

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team