scc_firewall_manager_sdk.MSPApi¶

All URIs are relative to https://api.us.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
add_users_to_tenant_in_msp_portal	POST /v1/msp/tenants/{tenantUid}/users	Add users to Security Cloud Control tenant in MSP Portal
create_tenant	POST /v1/msp/tenants/create	Create Security Cloud Control Tenant
delete_users_from_tenant_in_msp_portal	POST /v1/msp/tenants/{tenantUid}/users/delete	Remove users from Security Cloud Control tenant in MSP Portal
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
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_msp_managed_tenant	GET /v1/msp/tenants/{tenantUid}	Get 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_users_in_tenant_in_msp_portal	GET /v1/msp/tenants/{tenantUid}/users	Get Users associated with tenant in MSP portal
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

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.MSPApi(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 MSPApi->add_msp_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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.MSPApi(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 MSPApi->add_tenant_to_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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]

add_users_to_tenant_in_msp_portal¶

CdoTransaction add_users_to_tenant_in_msp_portal(tenant_uid, msp_add_users_to_tenant_input)

Add users to Security Cloud Control tenant in MSP Portal

This is an asynchronous operation to add a list of users to 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.models.msp_add_users_to_tenant_input import MspAddUsersToTenantInput
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.MSPApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant to which the users will be added.
    msp_add_users_to_tenant_input = scc_firewall_manager_sdk.MspAddUsersToTenantInput() # MspAddUsersToTenantInput | 

    try:
        # Add users to Security Cloud Control tenant in MSP Portal
        api_response = api_instance.add_users_to_tenant_in_msp_portal(tenant_uid, msp_add_users_to_tenant_input)
        print("The response of MSPApi->add_users_to_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->add_users_to_tenant_in_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant to which the users will be added.
msp_add_users_to_tenant_input	MspAddUsersToTenantInput

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]

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.MSPApi(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 MSPApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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]

delete_users_from_tenant_in_msp_portal¶

CdoTransaction delete_users_from_tenant_in_msp_portal(tenant_uid, msp_delete_users_from_tenant_input)

Remove users from Security Cloud Control tenant in MSP Portal

This is an asynchronous operation to remove a list of users from 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.models.msp_delete_users_from_tenant_input import MspDeleteUsersFromTenantInput
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.MSPApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant from which the users will be deleted
    msp_delete_users_from_tenant_input = scc_firewall_manager_sdk.MspDeleteUsersFromTenantInput() # MspDeleteUsersFromTenantInput | 

    try:
        # Remove users from Security Cloud Control tenant in MSP Portal
        api_response = api_instance.delete_users_from_tenant_in_msp_portal(tenant_uid, msp_delete_users_from_tenant_input)
        print("The response of MSPApi->delete_users_from_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->delete_users_from_tenant_in_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant from which the users will be deleted
msp_delete_users_from_tenant_input	MspDeleteUsersFromTenantInput

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]

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.MSPApi(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 MSPApi->enable_multicloud_defense_for_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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]

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.MSPApi(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 MSPApi->generate_api_token_for_user_in_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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_msp_managed_tenant¶

MspManagedTenant get_msp_managed_tenant(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 import MspManagedTenant
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.MSPApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | The unique identifier of the tenant in Security Cloud Control.

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

Parameters¶

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

Return type¶

MspManagedTenant

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_tenants¶

MspManagedTenantPage get_msp_managed_tenants(limit=limit, offset=offset, q=q)

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_page import MspManagedTenantPage
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.MSPApi(api_client)
    limit = '50' # str | The number of results to retrieve. (optional) (default to '50')
    offset = '0' # str | The offset of the results retrieved. The Security Cloud Control API uses 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)

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

Parameters¶

Name	Type	Description	Notes
limit	str	The number of results to retrieve.	[optional] [default to '50']
offset	str	The offset of the results retrieved. The Security Cloud Control API uses 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]

Return type¶

MspManagedTenantPage

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_users_in_tenant_in_msp_portal¶

UserPage get_users_in_tenant_in_msp_portal(tenant_uid, limit=limit, offset=offset, q=q)

Get Users associated with tenant in MSP portal

Get a list of users associated with the Security Cloud Control tenant managed by MSP portal.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.user_page import UserPage
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.MSPApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant to retrieve the users for.
    limit = '50' # str | The number of results to retrieve. (optional) (default to '50')
    offset = '0' # str | The offset of the results retrieved. The Security Cloud Control API uses 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)

    try:
        # Get Users associated with tenant in MSP portal
        api_response = api_instance.get_users_in_tenant_in_msp_portal(tenant_uid, limit=limit, offset=offset, q=q)
        print("The response of MSPApi->get_users_in_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->get_users_in_tenant_in_msp_portal: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_uid	str	Unique identifier of the tenant to retrieve the users for.
limit	str	The number of results to retrieve.	[optional] [default to '50']
offset	str	The offset of the results retrieved. The Security Cloud Control API uses 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]

Return type¶

UserPage

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	List of User objects	-
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)

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.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.MSPApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | Unique identifier of the tenant that cdFMC provisioning will be enabled for.

    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)
        print("The response of MSPApi->provision_cd_fmc_for_tenant_in_msp_portal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MSPApi->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.

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]

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.

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.MSPApi(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 MSPApi->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]