ThousandEyes SDK Credentials API
Project description
thousandeyes-sdk-credentials
Manage credentials for transaction tests using the Credentials API.
The following permissions are required to access Credentials API endpoints:
Settings Tests Read
for read operations.Settings Tests Update
for write operations.View sensitive data in web transaction scripts
to view the encrypted value property of credentials.Settings Tests Create Transaction (Tx) Tests
to create credentials.
For more information about credentials, see Working With Secure Credentials.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.15
- 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-credentials
(you may need to run pip
with root permission: sudo pip install thousandeyes-sdk-credentials
)
Then import the package:
import thousandeyes_sdk.credentials
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.credentials
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.credentials
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.credentials.CredentialsApi(api_client)
credential_request = thousandeyes_sdk.credentials.CredentialRequest() # CredentialRequest |
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:
# Create credential
api_response = api_instance.create_credential(credential_request, aid=aid)
print("The response of CredentialsApi->create_credential:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CredentialsApi->create_credential: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com/v7
Class | Method | HTTP request | Description |
---|---|---|---|
CredentialsApi | create_credential | POST /credentials | Create credential |
CredentialsApi | delete_credential | DELETE /credentials/{id} | Delete credential |
CredentialsApi | get_credential | GET /credentials/{id} | Retrieve credential |
CredentialsApi | get_credentials | GET /credentials | List credentials |
CredentialsApi | update_credential | PUT /credentials/{id} | Update credential |
Documentation For Models
- Credential
- CredentialRequest
- CredentialWithoutValue
- Credentials
- Error
- Link
- SelfLinks
- UnauthorizedError
- ValidationError
- ValidationErrorItem
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thousandeyes_sdk_credentials-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 887c3a9db21a1553b4579f1f5f9f725b6bade0ad1c365969af4d522f268afc89 |
|
MD5 | 5d11078e1c530f40b67a995d803c5acc |
|
BLAKE2b-256 | 01f13289ff9787bb67610045ac1862a4376d741fff6812b6f4e3943639c6921c |
Hashes for thousandeyes_sdk_credentials-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84fd347def2a9191ee0d1f401727a47f7d9b8f8e30fb51b46464ffdd5d054118 |
|
MD5 | 65e96ec19ab53b330bebd075dc966088 |
|
BLAKE2b-256 | 1d413fa728799f3a2ebd5b04ed8a024d5e038ec4fe371ab3f18d0d0647dfc268 |