# python-msx-sdk **Repository Path**: mirrors_CiscoDevNet/python-msx-sdk ## Basic Information - **Project Name**: python-msx-sdk - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-10-22 - **Last Updated**: 2026-04-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # python-msx-sdk MSX SDK client. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.10 - Package version: 1.0.10 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. Python >=3.6 ## Installation & Usage ### pip install If the python package is hosted on a repository, you can install directly using: ```sh pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) Then import the package: ```python import python_msx_sdk ``` ### Setuptools Install via [Setuptools](http://pypi.python.org/pypi/setuptools). ```sh python setup.py install --user ``` (or `sudo python setup.py install` to install the package for all users) Then import the package: ```python import python_msx_sdk ``` ## Getting Started Please follow the [installation procedure](#installation--usage) and then run the following: ```python import time import python_msx_sdk from pprint import pprint from python_msx_sdk.api import auditing_generic_events_api from python_msx_sdk.model.error import Error from python_msx_sdk.model.generic_event import GenericEvent from python_msx_sdk.model.generic_event_create import GenericEventCreate # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = python_msx_sdk.Configuration( host = "http://localhost" ) # Enter a context with an instance of the API client with python_msx_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = auditing_generic_events_api.AuditingGenericEventsApi(api_client) generic_event_create = GenericEventCreate( severity=GenericEventSeverity("CRITICAL"), subtype="subtype_example", service="service_example", keywords="keyword_1 keyword_2 keyword_3", details={ "key": "key_example", }, trace=GenericEventTrace( trace_id="trace_id_example", span_id="span_id_example", parent_id="parent_id_example", ), security=GenericEventSecurity( client_id="client_id_example", user_id="user_id_example", username="username_example", tenant_id="tenant_id_example", tenant_name="tenant_name_example", provider_id="provider_id_example", original_username="original_username_example", ), description="description_example", ) # GenericEventCreate | try: # Create Generic Event api_response = api_instance.create_generic_event(generic_event_create) pprint(api_response) except python_msx_sdk.ApiException as e: print("Exception when calling AuditingGenericEventsApi->create_generic_event: %s\n" % e) ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AuditingGenericEventsApi* | [**create_generic_event**](docs/AuditingGenericEventsApi.md#create_generic_event) | **POST** /auditing/api/v8/genericevents | Create Generic Event *BillingCyclesApi* | [**add_billing_cycle**](docs/BillingCyclesApi.md#add_billing_cycle) | **POST** /billing/api/v8/cycles | Add a billing cycle. *BillingCyclesApi* | [**delete_billing_cycle**](docs/BillingCyclesApi.md#delete_billing_cycle) | **DELETE** /billing/api/v8/cycles/{id} | Delete a billing cycle. *BillingCyclesApi* | [**get_billing_cycle**](docs/BillingCyclesApi.md#get_billing_cycle) | **GET** /billing/api/v8/cycles/{id} | Get a billing cycle. *BillingCyclesApi* | [**get_billing_cycles_page**](docs/BillingCyclesApi.md#get_billing_cycles_page) | **GET** /billing/api/v8/cycles | Retrieve a page of billing cycles. *BillingCyclesApi* | [**process_billing_cycle**](docs/BillingCyclesApi.md#process_billing_cycle) | **POST** /billing/api/v8/cycles/process | Process a billing cycle. *BillingCyclesApi* | [**update_billing_cycle**](docs/BillingCyclesApi.md#update_billing_cycle) | **PUT** /billing/api/v8/cycles/{id} | Update billing cycle for an event type and tenant. *BillingEventsApi* | [**get_cost_summary**](docs/BillingEventsApi.md#get_cost_summary) | **GET** /billing/api/v8/events/costs | Retrieve a summary for tenant cost. *BillingEventsApi* | [**get_event**](docs/BillingEventsApi.md#get_event) | **GET** /billing/api/v8/events/{id} | Get an Event. *BillingEventsApi* | [**get_events_page**](docs/BillingEventsApi.md#get_events_page) | **GET** /billing/api/v8/events | Retrieve a page of events for tenant. *BillingPricesApi* | [**add_price**](docs/BillingPricesApi.md#add_price) | **POST** /billing/api/v8/prices | Add price for tenant and event type. *BillingPricesApi* | [**delete_price**](docs/BillingPricesApi.md#delete_price) | **DELETE** /billing/api/v8/prices/{id} | Delete a price. *BillingPricesApi* | [**get_price**](docs/BillingPricesApi.md#get_price) | **GET** /billing/api/v8/prices/{id} | Get a price. *BillingPricesApi* | [**get_prices_page**](docs/BillingPricesApi.md#get_prices_page) | **GET** /billing/api/v8/prices | Retrieve a page of prices. *BillingPricesApi* | [**update_price**](docs/BillingPricesApi.md#update_price) | **PUT** /billing/api/v8/prices/{id} | Update price for an event type and tenant. *DeviceTemplatesApi* | [**create_device_template**](docs/DeviceTemplatesApi.md#create_device_template) | **POST** /manage/api/v8/devicetemplates | Creates a device template. *DeviceTemplatesApi* | [**create_device_template_version**](docs/DeviceTemplatesApi.md#create_device_template_version) | **POST** /manage/api/v8/devicetemplates/versions | Creates a new version of an existing device template. *DeviceTemplatesApi* | [**delete_device_template**](docs/DeviceTemplatesApi.md#delete_device_template) | **DELETE** /manage/api/v8/devicetemplates/{id} | Deletes a device template. *DeviceTemplatesApi* | [**get_device_template**](docs/DeviceTemplatesApi.md#get_device_template) | **GET** /manage/api/v8/devicetemplates/{id} | Returns a device template. *DeviceTemplatesApi* | [**get_device_templates_list**](docs/DeviceTemplatesApi.md#get_device_templates_list) | **GET** /manage/api/v8/devicetemplates/list | Returns a list of device templates. *DeviceTemplatesApi* | [**scan_device_template_parameters**](docs/DeviceTemplatesApi.md#scan_device_template_parameters) | **POST** /manage/api/v8/devicetemplates/parameters/scan | API to scan parameters from the device template XML. *DeviceTemplatesApi* | [**update_device_template_access**](docs/DeviceTemplatesApi.md#update_device_template_access) | **PUT** /manage/api/v8/devicetemplates/{id}/access | Updates device template access. *DevicesApi* | [**attach_device_templates**](docs/DevicesApi.md#attach_device_templates) | **POST** /manage/api/v8/devices/{id}/templates | Attaches one or more device templates to a device instance. *DevicesApi* | [**batch_attach_device_templates**](docs/DevicesApi.md#batch_attach_device_templates) | **POST** /manage/api/v8/devices/templates/attach | Attaches one or more device templates to a batch of device instances. *DevicesApi* | [**create_device**](docs/DevicesApi.md#create_device) | **POST** /manage/api/v8/devices | Creates a device. *DevicesApi* | [**delete_device**](docs/DevicesApi.md#delete_device) | **DELETE** /manage/api/v8/devices/{id} | Deletes a device. *DevicesApi* | [**detach_device_template**](docs/DevicesApi.md#detach_device_template) | **DELETE** /manage/api/v8/devices/{id}/templates/{templateId} | Detaches a template from a device. *DevicesApi* | [**detach_device_templates**](docs/DevicesApi.md#detach_device_templates) | **DELETE** /manage/api/v8/devices/{id}/templates | Detach device templates that are already attached to a device. *DevicesApi* | [**get_device**](docs/DevicesApi.md#get_device) | **GET** /manage/api/v8/devices/{id} | Returns a device. *DevicesApi* | [**get_device_config**](docs/DevicesApi.md#get_device_config) | **GET** /manage/api/v8/devices/{id}/config | Returns the running configuration for a device. *DevicesApi* | [**get_device_template_history**](docs/DevicesApi.md#get_device_template_history) | **GET** /manage/api/v8/devices/{id}/templates | Returns device template history. *DevicesApi* | [**get_devices_page**](docs/DevicesApi.md#get_devices_page) | **GET** /manage/api/v8/devices | Returns a page of devices. *DevicesApi* | [**patch_device**](docs/DevicesApi.md#patch_device) | **PATCH** /manage/api/v8/devices/{id} | Update a device. *DevicesApi* | [**redeploy_device**](docs/DevicesApi.md#redeploy_device) | **POST** /manage/api/v8/devices/{id}/redeploy | Dedeploys a device. *DevicesApi* | [**update_device**](docs/DevicesApi.md#update_device) | **PUT** /manage/api/v8/devices/{id} | Update a device. *DevicesApi* | [**update_device_config**](docs/DevicesApi.md#update_device_config) | **POST** /manage/api/v8/devices/{id}/config/update | push device configuration to the actual device *DevicesApi* | [**update_device_templates**](docs/DevicesApi.md#update_device_templates) | **PUT** /manage/api/v8/devices/{id}/templates | Update device templates that are already attached to a device. *HealthApi* | [**get_devices_health_list**](docs/HealthApi.md#get_devices_health_list) | **GET** /monitor/api/v8/health/devices/list | *HealthApi* | [**get_services_health_list**](docs/HealthApi.md#get_services_health_list) | **GET** /monitor/api/v8/health/services/list | *IncidentChangeRequestsApi* | [**create_change_request**](docs/IncidentChangeRequestsApi.md#create_change_request) | **POST** /incident/api/v8/changerequests | Create a change request. *IncidentChangeRequestsApi* | [**delete_change_request**](docs/IncidentChangeRequestsApi.md#delete_change_request) | **DELETE** /incident/api/v8/changerequests/{id} | Deletes a change request. *IncidentChangeRequestsApi* | [**get_change_request**](docs/IncidentChangeRequestsApi.md#get_change_request) | **GET** /incident/api/v8/changerequests/{id} | Returns a change request. *IncidentChangeRequestsApi* | [**get_change_requests_page**](docs/IncidentChangeRequestsApi.md#get_change_requests_page) | **GET** /incident/api/v8/changerequests | Returns a filtered list of change requests. *IncidentChangeRequestsApi* | [**update_change_request**](docs/IncidentChangeRequestsApi.md#update_change_request) | **PUT** /incident/api/v8/changerequests/{id} | Updates a change request. *IncidentConfigurationsApi* | [**create_service_now_configuration**](docs/IncidentConfigurationsApi.md#create_service_now_configuration) | **POST** /incident/api/v8/configurations | Creates a ServiceNow configuration. *IncidentConfigurationsApi* | [**delete_service_now_configuration**](docs/IncidentConfigurationsApi.md#delete_service_now_configuration) | **DELETE** /incident/api/v8/configurations/{id} | Deletes a ServiceNow configuration. *IncidentConfigurationsApi* | [**get_configuration**](docs/IncidentConfigurationsApi.md#get_configuration) | **GET** /incident/api/v1/config | API to get configuration of encloud service. *IncidentConfigurationsApi* | [**get_service_now_configuration**](docs/IncidentConfigurationsApi.md#get_service_now_configuration) | **GET** /incident/api/v8/configurations/{id} | Returns a ServiceNow configuration. *IncidentConfigurationsApi* | [**get_service_now_configurations_page**](docs/IncidentConfigurationsApi.md#get_service_now_configurations_page) | **GET** /incident/api/v8/configurations | Returns a ServiceNow configurations. *IncidentConfigurationsApi* | [**patch_configuration**](docs/IncidentConfigurationsApi.md#patch_configuration) | **PATCH** /incident/api/v1/config | API to patch configure encloud service *IncidentConfigurationsApi* | [**update_configuration**](docs/IncidentConfigurationsApi.md#update_configuration) | **PUT** /incident/api/v1/config | API to configure encloud service. *IncidentsApi* | [**cancel_incident**](docs/IncidentsApi.md#cancel_incident) | **PATCH** /incident/api/v1/incidents/{id}/cancel | Cancels an incident. *IncidentsApi* | [**create_incident**](docs/IncidentsApi.md#create_incident) | **POST** /incident/api/v1/incidents | Create a new Incident. *IncidentsApi* | [**delete_incident**](docs/IncidentsApi.md#delete_incident) | **DELETE** /incident/api/v1/incidents/{id} | Deletes an incident. *IncidentsApi* | [**get_incident**](docs/IncidentsApi.md#get_incident) | **GET** /incident/api/v1/incidents/{id} | Get incident details. *IncidentsApi* | [**get_incidents**](docs/IncidentsApi.md#get_incidents) | **GET** /incident/api/v1/incidents | Get Incidents by filter. *IncidentsApi* | [**update_incident**](docs/IncidentsApi.md#update_incident) | **PUT** /incident/api/v1/incidents/{id} | Updates an incident. *LicensingAccountsApi* | [**get_user_accounts_list**](docs/LicensingAccountsApi.md#get_user_accounts_list) | **GET** /licensing/api/v8/accounts/smart/list | Returns a filtered page of smart accounts. *LicensingConfigurationsApi* | [**create_smart_account_configuration**](docs/LicensingConfigurationsApi.md#create_smart_account_configuration) | **POST** /licensing/api/v8/configuration | Creates a smart account configuration. *LicensingConfigurationsApi* | [**get_smart_account_configuration**](docs/LicensingConfigurationsApi.md#get_smart_account_configuration) | **GET** /licensing/api/v8/configuration | Returns a smart account configuration. *LicensingConfigurationsApi* | [**update_smart_account_configuration**](docs/LicensingConfigurationsApi.md#update_smart_account_configuration) | **PUT** /licensing/api/v8/configuration | Updates a smart account configuration. *LicensingLicensesApi* | [**get_licenses_list**](docs/LicensingLicensesApi.md#get_licenses_list) | **GET** /licensing/api/v8/licensing/api/v8/licenses/list | Returns a filtered list of licenses. *OffersApi* | [**create_offer**](docs/OffersApi.md#create_offer) | **POST** /consume/api/v8/offers | Creates a product offer. *OffersApi* | [**delete_offer**](docs/OffersApi.md#delete_offer) | **DELETE** /consume/api/v8/offers/{id} | Deletes a product offer *OffersApi* | [**get_offer**](docs/OffersApi.md#get_offer) | **GET** /consume/api/v8/offers/{id} | Returns a product offer. *OffersApi* | [**get_offer_assignments_list**](docs/OffersApi.md#get_offer_assignments_list) | **GET** /consume/api/v8/offers/{id}/assignments/list | Returns a list of tenant assignments for a product offer. *OffersApi* | [**get_offers_count**](docs/OffersApi.md#get_offers_count) | **GET** /consume/api/v8/offers/count | Returns the number of product offers. *OffersApi* | [**get_offers_page**](docs/OffersApi.md#get_offers_page) | **GET** /consume/api/v8/offers | Returns a page of product offers. *OffersApi* | [**update_offer**](docs/OffersApi.md#update_offer) | **PUT** /consume/api/v8/offers/{id} | Updates a product offer. *OffersApi* | [**update_offer_assignments**](docs/OffersApi.md#update_offer_assignments) | **PUT** /consume/api/v8/offers/{id}/assignments | Updates the tenant assignemnts for a product offer. *ProductsApi* | [**create_product**](docs/ProductsApi.md#create_product) | **POST** /consume/api/v8/products | Creates a product. *ProductsApi* | [**delete_product**](docs/ProductsApi.md#delete_product) | **DELETE** /consume/api/v8/products/{id} | Deletes a product. *ProductsApi* | [**get_product**](docs/ProductsApi.md#get_product) | **GET** /consume/api/v8/products/{id} | Returns a product. *ProductsApi* | [**get_product_assignments_list**](docs/ProductsApi.md#get_product_assignments_list) | **GET** /consume/api/v8/products/{id}/assignments/list | Returns a list of tenant assignments for a product . *ProductsApi* | [**get_products_count**](docs/ProductsApi.md#get_products_count) | **GET** /consume/api/v8/products/count | Returns the number of products. *ProductsApi* | [**get_products_page**](docs/ProductsApi.md#get_products_page) | **GET** /consume/api/v8/products | Returns a page of products. *ProductsApi* | [**update_product**](docs/ProductsApi.md#update_product) | **PUT** /consume/api/v8/products/{id} | Updates a product. *ProductsApi* | [**update_product_assignments**](docs/ProductsApi.md#update_product_assignments) | **PUT** /consume/api/v8/products/{id}/assignments | Updates the tenant assignments for a product. *RegistrationApi* | [**delete_registered_product_version**](docs/RegistrationApi.md#delete_registered_product_version) | **DELETE** /vulnerability/api/v8/vulnerabilities/registrations/{id} | Delete a registration. *RegistrationApi* | [**get_registered_product_version_page**](docs/RegistrationApi.md#get_registered_product_version_page) | **GET** /vulnerability/api/v8/vulnerabilities/registrations | Returns a filtered page of registered products / versions. *RegistrationApi* | [**register_product_version**](docs/RegistrationApi.md#register_product_version) | **POST** /vulnerability/api/v8/vulnerabilities/registrations | Register a product / verison combination for vulnerability inspection. *RolesApi* | [**get_role_by_name**](docs/RolesApi.md#get_role_by_name) | **GET** /idm/api/v8/roles/name/{name} | Returns a role by name. *RolesApi* | [**get_roles_list**](docs/RolesApi.md#get_roles_list) | **GET** /idm/api/v8/roles/list | Returns a list of roles. *SecurityApi* | [**get_access_token**](docs/SecurityApi.md#get_access_token) | **POST** /idm/v2/token | Returns an access token. *ServicesApi* | [**delete_service**](docs/ServicesApi.md#delete_service) | **DELETE** /manage/api/v8/services/{id} | Deletes a service. *ServicesApi* | [**get_service**](docs/ServicesApi.md#get_service) | **GET** /manage/api/v8/services/{id} | Returns a service. *ServicesApi* | [**get_services_page**](docs/ServicesApi.md#get_services_page) | **GET** /manage/api/v8/services | Returns a page of services. *ServicesApi* | [**submit_order**](docs/ServicesApi.md#submit_order) | **POST** /manage/api/v8/services | Submits an order. *ServicesApi* | [**update_order**](docs/ServicesApi.md#update_order) | **PUT** /manage/api/v8/services | Updates an order. *ServicesApi* | [**update_service**](docs/ServicesApi.md#update_service) | **PUT** /manage/api/v8/services/{id} | Updates a service. *SitesApi* | [**add_devices_to_site**](docs/SitesApi.md#add_devices_to_site) | **POST** /manage/api/v8/sites/{id}/devices/add | Add devices to a site. *SitesApi* | [**add_services_to_site**](docs/SitesApi.md#add_services_to_site) | **POST** /manage/api/v8/sites/{id}/services/add | Add services to a site. *SitesApi* | [**create_site**](docs/SitesApi.md#create_site) | **POST** /manage/api/v8/sites | Creates a new site. *SitesApi* | [**delete_site**](docs/SitesApi.md#delete_site) | **DELETE** /manage/api/v8/sites/{id} | Deletes a site. *SitesApi* | [**get_site**](docs/SitesApi.md#get_site) | **GET** /manage/api/v8/sites/{id} | Returns a site. *SitesApi* | [**get_sites_page**](docs/SitesApi.md#get_sites_page) | **GET** /manage/api/v8/sites | Returns a page of Sites. Only one filter is supported at a time. *SitesApi* | [**remove_devices_from_site**](docs/SitesApi.md#remove_devices_from_site) | **POST** /manage/api/v8/sites/{id}/devices/remove | Removes devices from a site. *SitesApi* | [**remove_services_from_site**](docs/SitesApi.md#remove_services_from_site) | **POST** /manage/api/v8/sites/{id}/services/remove | Remove services from a site. *SitesApi* | [**update_site**](docs/SitesApi.md#update_site) | **PUT** /manage/api/v8/sites/{id} | Updates a site. *TemplateApplicationsApi* | [**apply_template**](docs/TemplateApplicationsApi.md#apply_template) | **POST** /template/api/v8/templates/{id}/applications | Applies a template to a target. *TemplateApplicationsApi* | [**delete_template_application**](docs/TemplateApplicationsApi.md#delete_template_application) | **DELETE** /template/api/v8/templates/applications/{id} | Deletes a template application. *TemplateApplicationsApi* | [**get_template_application**](docs/TemplateApplicationsApi.md#get_template_application) | **GET** /template/api/v8/templates/applications/{id} | Gets a template application. *TemplateApplicationsApi* | [**get_template_application_history**](docs/TemplateApplicationsApi.md#get_template_application_history) | **GET** /template/api/v8/templates/applications/{id}/history | Gets a template application history. *TemplateApplicationsApi* | [**get_template_applications_page**](docs/TemplateApplicationsApi.md#get_template_applications_page) | **GET** /template/api/v8/templates/applications | Get a page of template applications. *TemplateApplicationsApi* | [**update_application_status**](docs/TemplateApplicationsApi.md#update_application_status) | **PATCH** /template/api/v8/templates/applications/{id} | Updates an application status. *TemplateAssignmentsApi* | [**batch_assign_template**](docs/TemplateAssignmentsApi.md#batch_assign_template) | **POST** /template/api/v8/templates/{id}/assignments/add | Assigns a template to one or more tenants. *TemplateAssignmentsApi* | [**batch_unassign_template**](docs/TemplateAssignmentsApi.md#batch_unassign_template) | **POST** /template/api/v8/templates/{id}/assignments/remove | Unassigns a template from one or more tenants. *TemplateAssignmentsApi* | [**get_assignment**](docs/TemplateAssignmentsApi.md#get_assignment) | **GET** /template/api/v8/templates/assignments/{id} | Gets a template assignment. *TemplateAssignmentsApi* | [**get_assignment_history**](docs/TemplateAssignmentsApi.md#get_assignment_history) | **GET** /template/api/v8/templates/assignments/{id}/history | Gets a template assignment history. *TemplateAssignmentsApi* | [**get_template_assignments_page**](docs/TemplateAssignmentsApi.md#get_template_assignments_page) | **GET** /template/api/v8/templates/assignments | Returns a page of template assignments. *TemplateAssignmentsApi* | [**update_assignment_status**](docs/TemplateAssignmentsApi.md#update_assignment_status) | **PATCH** /template/api/v8/templates/assignments/{id} | Updates a template assignment status. *TemplatesApi* | [**delete_template**](docs/TemplatesApi.md#delete_template) | **DELETE** /template/api/v8/templates/{id} | Deletes a template. *TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /template/api/v8/templates/{id} | Returns a template by id. *TemplatesApi* | [**get_template_history**](docs/TemplatesApi.md#get_template_history) | **GET** /template/api/v8/templates/{id}/history | Returns a template history by id. *TemplatesApi* | [**get_templates_page**](docs/TemplatesApi.md#get_templates_page) | **GET** /template/api/v8/templates | Returns a page of templates. *TemplatesApi* | [**import_template**](docs/TemplatesApi.md#import_template) | **POST** /template/api/v8/templates | Imports a template. *TemplatesApi* | [**update_template_status**](docs/TemplatesApi.md#update_template_status) | **PATCH** /template/api/v8/templates/{id} | Updates a template status. *TenantsApi* | [**create_tenant**](docs/TenantsApi.md#create_tenant) | **POST** /idm/api/v8/tenants | Creates a new tenant. *TenantsApi* | [**delete_tenant**](docs/TenantsApi.md#delete_tenant) | **DELETE** /idm/api/v8/tenants/{id} | Deletes a tenant by id. *TenantsApi* | [**get_tenant**](docs/TenantsApi.md#get_tenant) | **GET** /idm/api/v8/tenants/{id} | Returns a tenant by id. *TenantsApi* | [**get_tenant_by_external_id**](docs/TenantsApi.md#get_tenant_by_external_id) | **GET** /idm/api/v8/tenants/externalId/{externalId} | Returns a tenant by externalId. *TenantsApi* | [**get_tenants_list**](docs/TenantsApi.md#get_tenants_list) | **GET** /idm/api/v8/tenants/list | Returns a list of tenants. *TenantsApi* | [**get_tenants_page**](docs/TenantsApi.md#get_tenants_page) | **GET** /idm/api/v8/tenants | Returns a page of tenants. *TenantsApi* | [**update_tenant**](docs/TenantsApi.md#update_tenant) | **PUT** /idm/api/v8/tenants/{id} | Updates a tenant by id. *UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /idm/api/v8/users | Creates a new user. *UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /idm/api/v8/users/{id} | Deletes a user by id. *UsersApi* | [**get_current_user**](docs/UsersApi.md#get_current_user) | **GET** /idm/api/v8/users/current | Returns the current user. *UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /idm/api/v8/users/{id} | Returns an existing user. *UsersApi* | [**get_users_page**](docs/UsersApi.md#get_users_page) | **GET** /idm/api/v8/users | Returns a page of users. *UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /idm/api/v8/users/{id} | Updates an existing user. *UsersApi* | [**update_user_password**](docs/UsersApi.md#update_user_password) | **PUT** /idm/api/v8/users/updatepassword | Update a user password. *ValidationApi* | [**get_validate_product_version_page**](docs/ValidationApi.md#get_validate_product_version_page) | **GET** /vulnerability/api/v8/vulnerabilities/validations | Returns a filtered page of validations. *ValidationApi* | [**validate_product_version**](docs/ValidationApi.md#validate_product_version) | **POST** /vulnerability/api/v8/vulnerabilities/validations | Validate registered product / verison combinations for vulnerabilities. *VulnerabilitiesApi* | [**get_ingest_vulnerabilities_tasks_page**](docs/VulnerabilitiesApi.md#get_ingest_vulnerabilities_tasks_page) | **GET** /vulnerability/api/v8/vulnerabilities/ingests | Returns a filtered page of ingest tasks. *VulnerabilitiesApi* | [**get_vulnerabilities_page**](docs/VulnerabilitiesApi.md#get_vulnerabilities_page) | **GET** /vulnerability/api/v8/vulnerabilities | Returns a filtered page of vulnerabilities. *VulnerabilitiesApi* | [**ingest_vulnerabilities**](docs/VulnerabilitiesApi.md#ingest_vulnerabilities) | **POST** /vulnerability/api/v8/vulnerabilities/ingests | Ingests a CVE JSON feed into the Vulnerability Service datastore. *WorkflowCategoriesApi* | [**create_workflow_category**](docs/WorkflowCategoriesApi.md#create_workflow_category) | **POST** /workflow/api/v8/categories | Creates a new workflow category. *WorkflowCategoriesApi* | [**delete_workflow_category**](docs/WorkflowCategoriesApi.md#delete_workflow_category) | **DELETE** /workflow/api/v8/categories/{id} | Deletes a workflow category. *WorkflowCategoriesApi* | [**get_workflow_categories_list**](docs/WorkflowCategoriesApi.md#get_workflow_categories_list) | **GET** /workflow/api/v8/categories/list | Returns a list of workflow categories. *WorkflowCategoriesApi* | [**get_workflow_category**](docs/WorkflowCategoriesApi.md#get_workflow_category) | **GET** /workflow/api/v8/categories/{id} | Returns a workflow category. *WorkflowCategoriesApi* | [**update_workflow_category**](docs/WorkflowCategoriesApi.md#update_workflow_category) | **PUT** /workflow/api/v8/categories/{id} | Updates a workflow category. *WorkflowEventsApi* | [**create_workflow_event**](docs/WorkflowEventsApi.md#create_workflow_event) | **POST** /workflow/api/v8/events | Creates a new workflow event. *WorkflowEventsApi* | [**delete_workflow_event**](docs/WorkflowEventsApi.md#delete_workflow_event) | **DELETE** /workflow/api/v8/events/{id} | Deletes a workflow event. *WorkflowEventsApi* | [**get_workflow_event**](docs/WorkflowEventsApi.md#get_workflow_event) | **GET** /workflow/api/v8/events/{id} | Returns a workflow event. *WorkflowEventsApi* | [**get_workflow_events_list**](docs/WorkflowEventsApi.md#get_workflow_events_list) | **GET** /workflow/api/v8/events/list | Returns a list of workflow events. *WorkflowEventsApi* | [**update_workflow_event**](docs/WorkflowEventsApi.md#update_workflow_event) | **PUT** /workflow/api/v8/events/{id} | Updates a workflow event. *WorkflowInstancesApi* | [**cancel_workflow_instance**](docs/WorkflowInstancesApi.md#cancel_workflow_instance) | **POST** /workflow/api/v8/workflows/instances/{id}/cancel | Cancels a workflow instance. *WorkflowInstancesApi* | [**delete_workflow_instance**](docs/WorkflowInstancesApi.md#delete_workflow_instance) | **DELETE** /workflow/api/v8/workflows/instances/{id} | Deletes a workflow instance. *WorkflowInstancesApi* | [**get_workflow_instance**](docs/WorkflowInstancesApi.md#get_workflow_instance) | **GET** /workflow/api/v8/workflows/instances/{id} | Returns a workflow instance. *WorkflowInstancesApi* | [**get_workflow_instance_action**](docs/WorkflowInstancesApi.md#get_workflow_instance_action) | **GET** /workflow/api/v8/workflows/instances/{id}/actions/{actionId} | Returns a workflow instance action. *WorkflowInstancesApi* | [**get_workflow_instances_list**](docs/WorkflowInstancesApi.md#get_workflow_instances_list) | **GET** /workflow/api/v8/workflows/{id}/instances/list | Returns a list of workflow instances. *WorkflowSchemasApi* | [**get_workflow_schema**](docs/WorkflowSchemasApi.md#get_workflow_schema) | **GET** /workflow/api/v8/schemas/{id} | Returns a workflow schema. *WorkflowSchemasApi* | [**get_workflow_schemas_list**](docs/WorkflowSchemasApi.md#get_workflow_schemas_list) | **GET** /workflow/api/v8/schemas/list | Returns a list of workflow schemas. *WorkflowTargetsApi* | [**create_workflow_target**](docs/WorkflowTargetsApi.md#create_workflow_target) | **POST** /workflow/api/v8/targets | Creates a new workflow target. *WorkflowTargetsApi* | [**delete_workflow_target**](docs/WorkflowTargetsApi.md#delete_workflow_target) | **DELETE** /workflow/api/v8/targets/{id} | Deletes a workflow target. *WorkflowTargetsApi* | [**get_workflow_target**](docs/WorkflowTargetsApi.md#get_workflow_target) | **GET** /workflow/api/v8/targets/{id} | Returns a workflow target. *WorkflowTargetsApi* | [**get_workflow_targets_list**](docs/WorkflowTargetsApi.md#get_workflow_targets_list) | **GET** /workflow/api/v8/targets/list | Returns a list of workflow targets. *WorkflowTargetsApi* | [**update_workflow_target**](docs/WorkflowTargetsApi.md#update_workflow_target) | **PUT** /workflow/api/v8/targets/{id} | Updates a workflow target. *WorkflowsApi* | [**delete_workflow**](docs/WorkflowsApi.md#delete_workflow) | **DELETE** /workflow/api/v8/workflows/{id} | Delete a workflow. *WorkflowsApi* | [**export_workflow**](docs/WorkflowsApi.md#export_workflow) | **GET** /workflow/api/v8/workflows/{id}/export | Exports a workflow. *WorkflowsApi* | [**get_workflow**](docs/WorkflowsApi.md#get_workflow) | **GET** /workflow/api/v8/workflows/{id} | Returns a workflow. *WorkflowsApi* | [**get_workflow_start_config**](docs/WorkflowsApi.md#get_workflow_start_config) | **GET** /workflow/api/v8/workflows/{id}/startconfig | Returns a workflow start config. *WorkflowsApi* | [**get_workflows_list**](docs/WorkflowsApi.md#get_workflows_list) | **GET** /workflow/api/v8/workflows/list | Returns a list of workflows. *WorkflowsApi* | [**import_workflow**](docs/WorkflowsApi.md#import_workflow) | **POST** /workflow/api/v8/workflows | Imports a workflow. *WorkflowsApi* | [**start_workflow**](docs/WorkflowsApi.md#start_workflow) | **POST** /workflow/api/v8/workflows/{id}/start | Starts a workflow. *WorkflowsApi* | [**update_workflow**](docs/WorkflowsApi.md#update_workflow) | **PUT** /workflow/api/v8/workflows/{id} | Updates a workflow. *WorkflowsApi* | [**validate_workflow**](docs/WorkflowsApi.md#validate_workflow) | **POST** /workflow/api/v8/workflows/{id}/validate | Validates a workflow. ## Documentation For Models - [AccessToken](docs/AccessToken.md) - [BillingCostsReport](docs/BillingCostsReport.md) - [BillingCycle](docs/BillingCycle.md) - [BillingCycleAllOf](docs/BillingCycleAllOf.md) - [BillingCycleCreate](docs/BillingCycleCreate.md) - [BillingCycleProcess](docs/BillingCycleProcess.md) - [BillingCycleProcessAccepted](docs/BillingCycleProcessAccepted.md) - [BillingCycleUpdate](docs/BillingCycleUpdate.md) - [BillingCyclesPage](docs/BillingCyclesPage.md) - [BillingCyclesPageAllOf](docs/BillingCyclesPageAllOf.md) - [BillingEvent](docs/BillingEvent.md) - [BillingEventAllOf](docs/BillingEventAllOf.md) - [BillingEventCreate](docs/BillingEventCreate.md) - [BillingEventUpdate](docs/BillingEventUpdate.md) - [BillingEventsPage](docs/BillingEventsPage.md) - [BillingEventsPageAllOf](docs/BillingEventsPageAllOf.md) - [BillingPrice](docs/BillingPrice.md) - [BillingPriceAllOf](docs/BillingPriceAllOf.md) - [BillingPriceCreate](docs/BillingPriceCreate.md) - [BillingPriceUpdate](docs/BillingPriceUpdate.md) - [BillingPricesPage](docs/BillingPricesPage.md) - [BillingPricesPageAllOf](docs/BillingPricesPageAllOf.md) - [CatalogAssignment](docs/CatalogAssignment.md) - [ChangeRequest](docs/ChangeRequest.md) - [ChangeRequestAllOf](docs/ChangeRequestAllOf.md) - [ChangeRequestCreate](docs/ChangeRequestCreate.md) - [ChangeRequestSummary](docs/ChangeRequestSummary.md) - [ChangeRequestUpdate](docs/ChangeRequestUpdate.md) - [ChangeRequestsPage](docs/ChangeRequestsPage.md) - [ChangeRequestsPageAllOf](docs/ChangeRequestsPageAllOf.md) - [CostSummary](docs/CostSummary.md) - [Device](docs/Device.md) - [DeviceAllOf](docs/DeviceAllOf.md) - [DeviceConfigUpdate](docs/DeviceConfigUpdate.md) - [DeviceCreate](docs/DeviceCreate.md) - [DeviceCreateAllOf](docs/DeviceCreateAllOf.md) - [DevicePatch](docs/DevicePatch.md) - [DeviceSummary](docs/DeviceSummary.md) - [DeviceTemplate](docs/DeviceTemplate.md) - [DeviceTemplateAccess](docs/DeviceTemplateAccess.md) - [DeviceTemplateAccessResponse](docs/DeviceTemplateAccessResponse.md) - [DeviceTemplateAttachRequest](docs/DeviceTemplateAttachRequest.md) - [DeviceTemplateBatchAttachRequest](docs/DeviceTemplateBatchAttachRequest.md) - [DeviceTemplateBatchAttachResponse](docs/DeviceTemplateBatchAttachResponse.md) - [DeviceTemplateCreate](docs/DeviceTemplateCreate.md) - [DeviceTemplateDetails](docs/DeviceTemplateDetails.md) - [DeviceTemplateHistory](docs/DeviceTemplateHistory.md) - [DeviceTemplateHistorySummary](docs/DeviceTemplateHistorySummary.md) - [DeviceTemplateUpdateDetails](docs/DeviceTemplateUpdateDetails.md) - [DeviceTemplateUpdateRequest](docs/DeviceTemplateUpdateRequest.md) - [DeviceTemplateVersionCreate](docs/DeviceTemplateVersionCreate.md) - [DeviceUpdate](docs/DeviceUpdate.md) - [DeviceUpdateAllOf](docs/DeviceUpdateAllOf.md) - [DevicesPage](docs/DevicesPage.md) - [DevicesPageAllOf](docs/DevicesPageAllOf.md) - [Error](docs/Error.md) - [GenericEvent](docs/GenericEvent.md) - [GenericEventAllOf](docs/GenericEventAllOf.md) - [GenericEventCreate](docs/GenericEventCreate.md) - [GenericEventSecurity](docs/GenericEventSecurity.md) - [GenericEventSeverity](docs/GenericEventSeverity.md) - [GenericEventTrace](docs/GenericEventTrace.md) - [Incident](docs/Incident.md) - [IncidentAllOf](docs/IncidentAllOf.md) - [IncidentCancel](docs/IncidentCancel.md) - [IncidentConfig](docs/IncidentConfig.md) - [IncidentConfigPatch](docs/IncidentConfigPatch.md) - [IncidentConfigUpdate](docs/IncidentConfigUpdate.md) - [IncidentCreate](docs/IncidentCreate.md) - [IncidentUpdate](docs/IncidentUpdate.md) - [IncidentsPage](docs/IncidentsPage.md) - [IncidentsPageAllOf](docs/IncidentsPageAllOf.md) - [LegacyAbsoluteConfig](docs/LegacyAbsoluteConfig.md) - [LegacyAddress](docs/LegacyAddress.md) - [LegacyNsoResponseTypes](docs/LegacyNsoResponseTypes.md) - [LegacyRelativeConfig](docs/LegacyRelativeConfig.md) - [LegacyScheduleConfig](docs/LegacyScheduleConfig.md) - [LegacyServiceOrder](docs/LegacyServiceOrder.md) - [LegacyServiceOrderDetail](docs/LegacyServiceOrderDetail.md) - [LegacyServiceOrderResponse](docs/LegacyServiceOrderResponse.md) - [LegacySite](docs/LegacySite.md) - [LegacySiteDevice](docs/LegacySiteDevice.md) - [LegacySiteDeviceOnboard](docs/LegacySiteDeviceOnboard.md) - [LegacySubscriptionDetail](docs/LegacySubscriptionDetail.md) - [LicenseDetails](docs/LicenseDetails.md) - [LicenseSummary](docs/LicenseSummary.md) - [ManageChangeRequestPending](docs/ManageChangeRequestPending.md) - [NSOConfigDataXPath](docs/NSOConfigDataXPath.md) - [NameValue](docs/NameValue.md) - [Offer](docs/Offer.md) - [OfferAllOf](docs/OfferAllOf.md) - [OfferCreate](docs/OfferCreate.md) - [OfferUpdate](docs/OfferUpdate.md) - [OffersPage](docs/OffersPage.md) - [OffersPageAllOf](docs/OffersPageAllOf.md) - [PageHeader](docs/PageHeader.md) - [Product](docs/Product.md) - [ProductAllOf](docs/ProductAllOf.md) - [ProductCreate](docs/ProductCreate.md) - [ProductUpdate](docs/ProductUpdate.md) - [ProductsPage](docs/ProductsPage.md) - [ProductsPageAllOf](docs/ProductsPageAllOf.md) - [ResourceHealth](docs/ResourceHealth.md) - [ResourceStatus](docs/ResourceStatus.md) - [ResourceType](docs/ResourceType.md) - [Role](docs/Role.md) - [Service](docs/Service.md) - [ServiceAllOf](docs/ServiceAllOf.md) - [ServiceElement](docs/ServiceElement.md) - [ServiceElementPrice](docs/ServiceElementPrice.md) - [ServiceNowConfiguration](docs/ServiceNowConfiguration.md) - [ServiceNowConfigurationCreate](docs/ServiceNowConfigurationCreate.md) - [ServiceNowConfigurationRequest](docs/ServiceNowConfigurationRequest.md) - [ServiceNowConfigurationsPage](docs/ServiceNowConfigurationsPage.md) - [ServiceNowConfigurationsPageAllOf](docs/ServiceNowConfigurationsPageAllOf.md) - [ServiceSLMUIConfig](docs/ServiceSLMUIConfig.md) - [ServiceUIConfig](docs/ServiceUIConfig.md) - [ServiceUILink](docs/ServiceUILink.md) - [ServiceUIResource](docs/ServiceUIResource.md) - [ServiceUpdate](docs/ServiceUpdate.md) - [ServicesPage](docs/ServicesPage.md) - [ServicesPageAllOf](docs/ServicesPageAllOf.md) - [Site](docs/Site.md) - [SiteAddress](docs/SiteAddress.md) - [SiteContact](docs/SiteContact.md) - [SiteCreate](docs/SiteCreate.md) - [SiteCreateAllOf](docs/SiteCreateAllOf.md) - [SiteLocation](docs/SiteLocation.md) - [SiteStatus](docs/SiteStatus.md) - [SiteUpdate](docs/SiteUpdate.md) - [SitesPage](docs/SitesPage.md) - [SitesPageAllOf](docs/SitesPageAllOf.md) - [SmartAccountConfiguration](docs/SmartAccountConfiguration.md) - [SmartAccountConfigurationCreate](docs/SmartAccountConfigurationCreate.md) - [SmartAccountConfigurationUpdate](docs/SmartAccountConfigurationUpdate.md) - [SmartAccountType](docs/SmartAccountType.md) - [SmartAccountUser](docs/SmartAccountUser.md) - [SmartAccountUserRole](docs/SmartAccountUserRole.md) - [SmartUserAccounts](docs/SmartUserAccounts.md) - [SmartUserAccountsAllOf](docs/SmartUserAccountsAllOf.md) - [StartWorkflowResponse](docs/StartWorkflowResponse.md) - [Template](docs/Template.md) - [TemplateApplication](docs/TemplateApplication.md) - [TemplateApplicationAllOf](docs/TemplateApplicationAllOf.md) - [TemplateApplicationCreate](docs/TemplateApplicationCreate.md) - [TemplateApplicationStatusPatch](docs/TemplateApplicationStatusPatch.md) - [TemplateApplicationsPage](docs/TemplateApplicationsPage.md) - [TemplateApplicationsPageAllOf](docs/TemplateApplicationsPageAllOf.md) - [TemplateAssignment](docs/TemplateAssignment.md) - [TemplateAssignmentAllOf](docs/TemplateAssignmentAllOf.md) - [TemplateAssignmentResponse](docs/TemplateAssignmentResponse.md) - [TemplateAssignmentResponseAllOf](docs/TemplateAssignmentResponseAllOf.md) - [TemplateAssignmentStatusPatch](docs/TemplateAssignmentStatusPatch.md) - [TemplateAssignmentsPage](docs/TemplateAssignmentsPage.md) - [TemplateAssignmentsPageAllOf](docs/TemplateAssignmentsPageAllOf.md) - [TemplateCreate](docs/TemplateCreate.md) - [TemplateParameterValidator](docs/TemplateParameterValidator.md) - [TemplatePatch](docs/TemplatePatch.md) - [TemplateStatus](docs/TemplateStatus.md) - [TemplateStatusMeta](docs/TemplateStatusMeta.md) - [TemplatesPage](docs/TemplatesPage.md) - [TemplatesPageAllOf](docs/TemplatesPageAllOf.md) - [Tenant](docs/Tenant.md) - [TenantAllOf](docs/TenantAllOf.md) - [TenantCreate](docs/TenantCreate.md) - [TenantCreateAllOf](docs/TenantCreateAllOf.md) - [TenantUpdate](docs/TenantUpdate.md) - [TenantsPage](docs/TenantsPage.md) - [TenantsPageAllOf](docs/TenantsPageAllOf.md) - [UpdatePassword](docs/UpdatePassword.md) - [User](docs/User.md) - [UserAllOf](docs/UserAllOf.md) - [UserCreate](docs/UserCreate.md) - [UserCreateAllOf](docs/UserCreateAllOf.md) - [UserUpdate](docs/UserUpdate.md) - [UsersPage](docs/UsersPage.md) - [UsersPageAllOf](docs/UsersPageAllOf.md) - [ValidateWorkflowResponse](docs/ValidateWorkflowResponse.md) - [VulnerabilitiesPage](docs/VulnerabilitiesPage.md) - [VulnerabilitiesPageAllOf](docs/VulnerabilitiesPageAllOf.md) - [VulnerabilitiesRegistrationPage](docs/VulnerabilitiesRegistrationPage.md) - [VulnerabilitiesRegistrationPageAllOf](docs/VulnerabilitiesRegistrationPageAllOf.md) - [Vulnerability](docs/Vulnerability.md) - [VulnerabilityFeed](docs/VulnerabilityFeed.md) - [VulnerabilityIngestPage](docs/VulnerabilityIngestPage.md) - [VulnerabilityIngestPageAllOf](docs/VulnerabilityIngestPageAllOf.md) - [VulnerabilityIngestion](docs/VulnerabilityIngestion.md) - [VulnerabilityRegistration](docs/VulnerabilityRegistration.md) - [VulnerabilityRegistrationAllOf](docs/VulnerabilityRegistrationAllOf.md) - [VulnerabilityRegistrationCreate](docs/VulnerabilityRegistrationCreate.md) - [VulnerabilitySeverity](docs/VulnerabilitySeverity.md) - [VulnerabilityValidation](docs/VulnerabilityValidation.md) - [VulnerabilityValidationPage](docs/VulnerabilityValidationPage.md) - [VulnerabilityValidationPageAllOf](docs/VulnerabilityValidationPageAllOf.md) - [Workflow](docs/Workflow.md) - [WorkflowAccessMeta](docs/WorkflowAccessMeta.md) - [WorkflowAccessMetaType](docs/WorkflowAccessMetaType.md) - [WorkflowAction](docs/WorkflowAction.md) - [WorkflowActionBlock](docs/WorkflowActionBlock.md) - [WorkflowAllOf](docs/WorkflowAllOf.md) - [WorkflowCategory](docs/WorkflowCategory.md) - [WorkflowCategoryAllOf](docs/WorkflowCategoryAllOf.md) - [WorkflowCategoryCreate](docs/WorkflowCategoryCreate.md) - [WorkflowCategoryUpdate](docs/WorkflowCategoryUpdate.md) - [WorkflowDefAccessMeta](docs/WorkflowDefAccessMeta.md) - [WorkflowEvent](docs/WorkflowEvent.md) - [WorkflowEventAllOf](docs/WorkflowEventAllOf.md) - [WorkflowEventCreate](docs/WorkflowEventCreate.md) - [WorkflowEventUpdate](docs/WorkflowEventUpdate.md) - [WorkflowFooter](docs/WorkflowFooter.md) - [WorkflowInstance](docs/WorkflowInstance.md) - [WorkflowInstanceAllOf](docs/WorkflowInstanceAllOf.md) - [WorkflowInstanceDeleteResponse](docs/WorkflowInstanceDeleteResponse.md) - [WorkflowMapping](docs/WorkflowMapping.md) - [WorkflowMetadata](docs/WorkflowMetadata.md) - [WorkflowMetadataGitInfo](docs/WorkflowMetadataGitInfo.md) - [WorkflowSchema](docs/WorkflowSchema.md) - [WorkflowSchemaAllOf](docs/WorkflowSchemaAllOf.md) - [WorkflowSchemaByTypeResponse](docs/WorkflowSchemaByTypeResponse.md) - [WorkflowStartConfig](docs/WorkflowStartConfig.md) - [WorkflowTarget](docs/WorkflowTarget.md) - [WorkflowTargetAllOf](docs/WorkflowTargetAllOf.md) - [WorkflowTargetCreate](docs/WorkflowTargetCreate.md) - [WorkflowTargetUpdate](docs/WorkflowTargetUpdate.md) - [WorkflowVariable](docs/WorkflowVariable.md) - [WorkflowVariableAllOf](docs/WorkflowVariableAllOf.md) ## Documentation For Authorization All endpoints do not require authorization. ## Author ## Notes for Large OpenAPI documents If the OpenAPI document is large, imports in python_msx_sdk.apis and python_msx_sdk.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - `from python_msx_sdk.api.default_api import DefaultApi` - `from python_msx_sdk.model.pet import Pet` Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: ``` import sys sys.setrecursionlimit(1500) import python_msx_sdk from python_msx_sdk.apis import * from python_msx_sdk.models import * ```