scc_firewall_manager_sdk.MSPTenantManagementApi¶

All URIs are relative to the base URL, which depends on the region your organization is deployed to.

Region	Base URL
US	https://api.us.security.cisco.com/firewall
EU	https://api.eu.security.cisco.com/firewall
APJ	https://api.apj.security.cisco.com/firewall
AU	https://api.au.security.cisco.com/firewall
IN	https://api.in.security.cisco.com/firewall
UAE	https://api.uae.security.cisco.com/firewall

Method	HTTP request	Description
add_msp_tenant	POST /v1/msp/tenants	Add Tenant to MSP Portal (API token)
add_tenant_to_msp_portal	POST /v1/msp/tenants/{tenantUid}	Add tenant to MSP Portal
bulk_update_msp_tenant_settings	PATCH /v1/msp/tenants/settings	Bulk update settings for Security Cloud Control tenants managed by MSP Portal
create_tenant	POST /v1/msp/tenants/create	Create Security Cloud Control Tenant
enable_multicloud_defense_for_tenant_in_msp_portal	POST /v1/msp/tenants/{tenantUid}/mcd	Enable Multicloud Defense for Security Cloud Control tenant in MSP Portal
export_msp_managed_tenants	POST /v1/msp/tenants/export	Export MSP-managed Tenants
generate_api_token_for_user_in_tenant	POST /v1/msp/tenants/{tenantUid}/users/{apiUserUid}/token	Generate token for API-only user on tenant managed by MSP portal
get_all_msp_managed_tenant_settings	GET /v1/msp/tenants/settings	Get Tenant Settings for all Security Cloud Control tenants managed by MSP Portal
get_msp_managed_tenant	GET /v1/msp/tenants/{managedTenantUid}	Get Security Cloud Control tenant managed by MSP Portal
get_msp_managed_tenant_settings	GET /v1/msp/tenants/{managedTenantUid}/settings	Get Tenant Settings for a Security Cloud Control tenant managed by MSP Portal
get_msp_managed_tenants	GET /v1/msp/tenants	Get Security Cloud Control tenants managed by MSP Portal
get_msp_managed_tenants_attribute_values	GET /v1/msp/tenants/attribute-values	Get distinct attribute values for MSP-managed tenants
provision_cd_fmc_for_tenant_in_msp_portal	POST /v1/msp/tenants/{tenantUid}/cdfmc	Provision cdFMC for Security Cloud Control tenant in MSP Portal
remove_tenant_from_msp_portal	DELETE /v1/msp/tenants/{tenantUid}	Remove tenant from MSP Portal
revoke_tenant_from_msp_portal	POST /v1/msp/tenants/{tenantUid}/revoke	Revoke manager -> managed relationship between tenant and MSP Portal
update_msp_tenant_api_token	PATCH /v1/msp/tenants/{managedTenantUid}	Update API Token for MSP Managed Tenant

add_msp_tenant¶

StatusInfo add_msp_tenant(msp_add_tenant_input)

Add Tenant to MSP Portal (API token)

Add a tenant to the MSP Portal by providing an API token for the tenant. Use this endpoint to add a tenant that the user performing the operation is not associated with, or a tenant in a different region to that of the MSP Portal. Note: This endpoint can only be executed by a super-admin in an MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_add_tenant_input import MspAddTenantInput
from scc_firewall_manager_sdk.models.status_info import StatusInfo
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    msp_add_tenant_input = scc_firewall_manager_sdk.MspAddTenantInput() # MspAddTenantInput | 

    try:
        # Add Tenant to MSP Portal (API token)
        api_response = api_instance.add_msp_tenant(msp_add_tenant_input)
        print("The response of MSPTenantManagementApi->add_msp_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->add_msp_tenant: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
msp_add_tenant_input	MspAddTenantInput

Return type¶

StatusInfo

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	Status	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_tenant_to_msp_portal¶

CdoTransaction add_tenant_to_msp_portal(tenant_uid)

Add tenant to MSP Portal

This is an asynchronous operation to add an existing tenant that the user making the API call is associated with to the MSP Portal. This endpoint will add an API-only user to the tenant, generate an API token for the API-only user, and add the tenant to the MSP Portal. Note: this endpoint can only be executed by a super-admin in the MSP Portal who is also associated with the tenant being added.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant to add to the MSP portal.

    try:
        # Add tenant to MSP Portal
        api_response = api_instance.add_tenant_to_msp_portal(tenant_uid)
        print("The response of MSPTenantManagementApi->add_tenant_to_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->add_tenant_to_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant to add to the MSP portal.

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the operation.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
409	Conflict.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bulk_update_msp_tenant_settings¶

CdoTransaction bulk_update_msp_tenant_settings(msp_tenant_settings_input)

Bulk update settings for Security Cloud Control tenants managed by MSP Portal

This is an asynchronous operation to update the settings of multiple Security Cloud Control tenants managed by the MSP Portal. Note: This endpoint can only be executed by a super-admin in an MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.models.msp_tenant_settings_input import MspTenantSettingsInput
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    msp_tenant_settings_input = scc_firewall_manager_sdk.MspTenantSettingsInput() # MspTenantSettingsInput | 

    try:
        # Bulk update settings for Security Cloud Control tenants managed by MSP Portal
        api_response = api_instance.bulk_update_msp_tenant_settings(msp_tenant_settings_input)
        print("The response of MSPTenantManagementApi->bulk_update_msp_tenant_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->bulk_update_msp_tenant_settings: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
msp_tenant_settings_input	MspTenantSettingsInput

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the operation.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_tenant¶

CdoTransaction create_tenant(msp_create_tenant_input)

Create Security Cloud Control Tenant

Create a new tenant in Security Cloud Control from an MSP Portal. This endpoint creates a tenant, adds the tenant to the MSP Portal. If the user creating the tenant is not an API-only user, the user is also added to the tenant. Note: This endpoint can only be executed by a super-admin in an MSP Portal. You can create no more than 1 tenant every 30 seconds. Additionally, you are limited to creating a total of 100 tenants: please speak to support to raise this limit.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.models.msp_create_tenant_input import MspCreateTenantInput
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    msp_create_tenant_input = scc_firewall_manager_sdk.MspCreateTenantInput() # MspCreateTenantInput | 

    try:
        # Create Security Cloud Control Tenant
        api_response = api_instance.create_tenant(msp_create_tenant_input)
        print("The response of MSPTenantManagementApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->create_tenant: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
msp_create_tenant_input	MspCreateTenantInput

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the tenant creation.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
409	Conflict.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_multicloud_defense_for_tenant_in_msp_portal¶

CdoTransaction enable_multicloud_defense_for_tenant_in_msp_portal(tenant_uid)

Enable Multicloud Defense for Security Cloud Control tenant in MSP Portal

This is an asynchronous operation to enable Multicloud Defense for a tenant associated with the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant that Multicloud Defense will be enabled for.

    try:
        # Enable Multicloud Defense for Security Cloud Control tenant in MSP Portal
        api_response = api_instance.enable_multicloud_defense_for_tenant_in_msp_portal(tenant_uid)
        print("The response of MSPTenantManagementApi->enable_multicloud_defense_for_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->enable_multicloud_defense_for_tenant_in_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant that Multicloud Defense will be enabled for.

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

export_msp_managed_tenants¶

CdoTransaction export_msp_managed_tenants(msp_export_input=msp_export_input)

Export MSP-managed Tenants

This is an asynchronous operation to export MSP-managed tenants in CSV format. Once complete, the file can be downloaded using a presigned AWS S3 URL specified in the entityUrl field of the transaction that expires in 1 hour.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.models.msp_export_input import MspExportInput
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    msp_export_input = scc_firewall_manager_sdk.MspExportInput() # MspExportInput |  (optional)

    try:
        # Export MSP-managed Tenants
        api_response = api_instance.export_msp_managed_tenants(msp_export_input=msp_export_input)
        print("The response of MSPTenantManagementApi->export_msp_managed_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->export_msp_managed_tenants: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
msp_export_input	MspExportInput		[optional]

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the export. Once complete, the <code>entityUrl</code> field of the transaction will contain a presigned AWS S3 URL, valid for 1 hour, to download the exported file.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generate_api_token_for_user_in_tenant¶

ApiTokenInfo generate_api_token_for_user_in_tenant(tenant_uid, api_user_uid)

Generate token for API-only user on tenant managed by MSP portal

Generate API Token for API-only user on a tenant managed by the MSP portal. API-only users are used for building automations with Security Cloud Control. If the user ID provided is not that of an API-only user, this operation will fail.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.api_token_info import ApiTokenInfo
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | The unique identifier of the tenant in Security Cloud Control.
    api_user_uid = 'api_user_uid_example' # str | The unique identifier of the API-only user in Security Cloud Control.

    try:
        # Generate token for API-only user on tenant managed by MSP portal
        api_response = api_instance.generate_api_token_for_user_in_tenant(tenant_uid, api_user_uid)
        print("The response of MSPTenantManagementApi->generate_api_token_for_user_in_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->generate_api_token_for_user_in_tenant: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	The unique identifier of the tenant in Security Cloud Control.
api_user_uid	str	The unique identifier of the API-only user in Security Cloud Control.

Return type¶

ApiTokenInfo

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	API Token	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_msp_managed_tenant_settings¶

MspManagedTenantSettingsDtoPage get_all_msp_managed_tenant_settings(limit=limit, offset=offset, q=q, sort=sort)

Get Tenant Settings for all Security Cloud Control tenants managed by MSP Portal

Get the settings for all Security Cloud Control tenants managed by the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_settings_dto_page import MspManagedTenantSettingsDtoPage
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    limit = '50' # str | Number of results to retrieve. (optional) (default to '50')
    offset = '0' # str | Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified. (optional) (default to '0')
    q = 'fieldName:fieldValue' # str | The query to execute. Use the Lucene Query Syntax to construct your query. (optional)
    sort = ['name:DESC'] # List[str] | The fields to sort results by. (optional)

    try:
        # Get Tenant Settings for all Security Cloud Control tenants managed by MSP Portal
        api_response = api_instance.get_all_msp_managed_tenant_settings(limit=limit, offset=offset, q=q, sort=sort)
        print("The response of MSPTenantManagementApi->get_all_msp_managed_tenant_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->get_all_msp_managed_tenant_settings: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
limit	str	Number of results to retrieve.	[optional] [default to '50']
offset	str	Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.	[optional] [default to '0']
q	str	The query to execute. Use the Lucene Query Syntax to construct your query.	[optional]
sort	List[str]	The fields to sort results by.	[optional]

Return type¶

MspManagedTenantSettingsDtoPage

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Page of tenant settings objects	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_msp_managed_tenant¶

MspManagedTenantDto get_msp_managed_tenant(managed_tenant_uid)

Get Security Cloud Control tenant managed by MSP Portal

Get a Security Cloud Control tenant managed by the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_dto import MspManagedTenantDto
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    managed_tenant_uid = 'managed_tenant_uid_example' # str | The unique identifier of the tenant in Security Cloud Control Firewall Manager. Note: this is different from the organization ID in Security Cloud Control.

    try:
        # Get Security Cloud Control tenant managed by MSP Portal
        api_response = api_instance.get_msp_managed_tenant(managed_tenant_uid)
        print("The response of MSPTenantManagementApi->get_msp_managed_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->get_msp_managed_tenant: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
managed_tenant_uid	str	The unique identifier of the tenant in Security Cloud Control Firewall Manager. Note: this is different from the organization ID in Security Cloud Control.

Return type¶

MspManagedTenantDto

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Security Cloud Control tenant object	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_msp_managed_tenant_settings¶

MspManagedTenantSettingsDto get_msp_managed_tenant_settings(managed_tenant_uid)

Get Tenant Settings for a Security Cloud Control tenant managed by MSP Portal

Get the settings for a specific Security Cloud Control tenant managed by the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_settings_dto import MspManagedTenantSettingsDto
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    managed_tenant_uid = 'managed_tenant_uid_example' # str | The unique identifier of the tenant in Security Cloud Control Firewall Manager.

    try:
        # Get Tenant Settings for a Security Cloud Control tenant managed by MSP Portal
        api_response = api_instance.get_msp_managed_tenant_settings(managed_tenant_uid)
        print("The response of MSPTenantManagementApi->get_msp_managed_tenant_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->get_msp_managed_tenant_settings: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
managed_tenant_uid	str	The unique identifier of the tenant in Security Cloud Control Firewall Manager.

Return type¶

MspManagedTenantSettingsDto

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Tenant settings object	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_msp_managed_tenants¶

MspManagedTenantDtoPage get_msp_managed_tenants(limit=limit, offset=offset, q=q, sort=sort)

Get Security Cloud Control tenants managed by MSP Portal

Get a list of Security Cloud Control tenants managed by the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_dto_page import MspManagedTenantDtoPage
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    limit = '50' # str | Number of results to retrieve. (optional) (default to '50')
    offset = '0' # str | Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified. (optional) (default to '0')
    q = 'fieldName:fieldValue' # str | The query to execute. Use the Lucene Query Syntax to construct your query. (optional)
    sort = ['name:DESC'] # List[str] | The fields to sort results by. (optional)

    try:
        # Get Security Cloud Control tenants managed by MSP Portal
        api_response = api_instance.get_msp_managed_tenants(limit=limit, offset=offset, q=q, sort=sort)
        print("The response of MSPTenantManagementApi->get_msp_managed_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->get_msp_managed_tenants: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
limit	str	Number of results to retrieve.	[optional] [default to '50']
offset	str	Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.	[optional] [default to '0']
q	str	The query to execute. Use the Lucene Query Syntax to construct your query.	[optional]
sort	List[str]	The fields to sort results by.	[optional]

Return type¶

MspManagedTenantDtoPage

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	List of Security Cloud Control tenant objects	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_msp_managed_tenants_attribute_values¶

MspManagedTenantDistinctAttributeValues get_msp_managed_tenants_attribute_values()

Get distinct attribute values for MSP-managed tenants

Get distinct values for multiple fields in the MSP-managed tenants managed by the MSP portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_distinct_attribute_values import MspManagedTenantDistinctAttributeValues
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)

    try:
        # Get distinct attribute values for MSP-managed tenants
        api_response = api_instance.get_msp_managed_tenants_attribute_values()
        print("The response of MSPTenantManagementApi->get_msp_managed_tenants_attribute_values:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->get_msp_managed_tenants_attribute_values: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

MspManagedTenantDistinctAttributeValues

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Distinct attribute values for MSP-managed devices	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

provision_cd_fmc_for_tenant_in_msp_portal¶

CdoTransaction provision_cd_fmc_for_tenant_in_msp_portal(tenant_uid, enable_cd_fmc_for_tenant_request=enable_cd_fmc_for_tenant_request)

Provision cdFMC for Security Cloud Control tenant in MSP Portal

This is an asynchronous operation to provision a cdFMC for a tenant associated with the MSP Portal. This operation does not wait for the cdFMC to be provisioned on the target tenant, and will be marked as successful once the provisioning has been successfully triggered. To monitor the transaction on the target tenant, use the UID in the TRANSACTION_UID_IN_TARGET_TENANT key in the transaction details.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.models.enable_cd_fmc_for_tenant_request import EnableCdFmcForTenantRequest
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant that cdFMC provisioning will be enabled for.
    enable_cd_fmc_for_tenant_request = scc_firewall_manager_sdk.EnableCdFmcForTenantRequest() # EnableCdFmcForTenantRequest |  (optional)

    try:
        # Provision cdFMC for Security Cloud Control tenant in MSP Portal
        api_response = api_instance.provision_cd_fmc_for_tenant_in_msp_portal(tenant_uid, enable_cd_fmc_for_tenant_request=enable_cd_fmc_for_tenant_request)
        print("The response of MSPTenantManagementApi->provision_cd_fmc_for_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->provision_cd_fmc_for_tenant_in_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant that cdFMC provisioning will be enabled for.
enable_cd_fmc_for_tenant_request	EnableCdFmcForTenantRequest		[optional]

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_tenant_from_msp_portal¶

remove_tenant_from_msp_portal(tenant_uid)

Remove tenant from MSP Portal

Removes a tenant currently associated with the MSP Portal. Note: this endpoint can only be executed by a super-admin in the MSP Portal. This endpoint is deprecated because it can take over 30 seconds to perform all of the revocation actions. Use the POST /tenants/{tenantUid}/revoke endpoint instead.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.

    try:
        # Remove tenant from MSP Portal
        api_instance.remove_tenant_from_msp_portal(tenant_uid)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->remove_tenant_from_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.

Return type¶

void (empty response body)

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
204	No Content	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_tenant_from_msp_portal¶

CdoTransaction revoke_tenant_from_msp_portal(tenant_uid)

Revoke manager -> managed relationship between tenant and MSP Portal

Revokes the manager-managed relationship between a tenant and the MSP Portal. This removes the tenant from the MSP Portal but does not delete the tenant itself. To delete the tenant, contact Cisco TAC. This endpoint can only be executed by a super-admin in the MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.

    try:
        # Revoke manager -> managed relationship between tenant and MSP Portal
        api_response = api_instance.revoke_tenant_from_msp_portal(tenant_uid)
        print("The response of MSPTenantManagementApi->revoke_tenant_from_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->revoke_tenant_from_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the operation.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_msp_tenant_api_token¶

MspManagedTenantDto update_msp_tenant_api_token(managed_tenant_uid, msp_update_tenant_api_token_input)

Update API Token for MSP Managed Tenant

Update the API token for an existing tenant managed by the MSP Portal. Use this endpoint to replace an expired or invalid API token. Note: This endpoint can only be executed by a super-admin in an MSP Portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.msp_managed_tenant_dto import MspManagedTenantDto
from scc_firewall_manager_sdk.models.msp_update_tenant_api_token_input import MspUpdateTenantApiTokenInput
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

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

# 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 (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.MSPTenantManagementApi(api_client)
    managed_tenant_uid = 'managed_tenant_uid_example' # str | The unique identifier of the tenant in Security Cloud Control Firewall Manager.
    msp_update_tenant_api_token_input = scc_firewall_manager_sdk.MspUpdateTenantApiTokenInput() # MspUpdateTenantApiTokenInput | 

    try:
        # Update API Token for MSP Managed Tenant
        api_response = api_instance.update_msp_tenant_api_token(managed_tenant_uid, msp_update_tenant_api_token_input)
        print("The response of MSPTenantManagementApi->update_msp_tenant_api_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPTenantManagementApi->update_msp_tenant_api_token: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
managed_tenant_uid	str	The unique identifier of the tenant in Security Cloud Control Firewall Manager.
msp_update_tenant_api_token_input	MspUpdateTenantApiTokenInput

Return type¶

MspManagedTenantDto

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: application/json
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Updated tenant	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]