thousandeyes-sdk-python/credentials_api

credentials-api

Overview

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.

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

• API version: 7.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git)

Then import the package:

import credentials_api

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 credentials_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import credentials_api
from credentials_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = credentials_api.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 = credentials_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with credentials_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = credentials_api.CredentialsApi(api_client)
    credential_request = credentials_api.CredentialRequest() # CredentialRequest | 
    aid = '2067' # 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_transaction_tests_credential(credential_request, aid=aid)
        print("The response of CredentialsApi->create_transaction_tests_credential:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CredentialsApi->create_transaction_tests_credential: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CredentialsApi	create_transaction_tests_credential	POST /v7/credentials	Create credential
CredentialsApi	delete_transaction_tests_credential	DELETE /v7/credentials/{id}	Delete credential
CredentialsApi	get_transaction_tests_credential_details	GET /v7/credentials/{id}	Retrieve credential
CredentialsApi	get_transaction_tests_credentials_list	GET /v7/credentials	List credentials
CredentialsApi	update_transaction_tests_credential	PUT /v7/credentials/{id}	Update credential

Documentation For Models

• Credential
• CredentialRequest
• CredentialWithoutValue
• Credentials
• Error
• GetTransactionTestsCredentialsList200Response
• Link
• SelfLinks
• SelfLinksLinks
• UnauthorizedError

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author