scc_firewall_manager_sdk.TenantManagementApi¶

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
get_feature_flags	GET /v1/features	Get Feature Flags
get_tenant	GET /v1/tenants/{tenantUid}	Get Tenant
get_tenant_settings	GET /v1/settings/tenant	Get Tenant Settings
get_tenants	GET /v1/tenants	Get Tenants
modify_tenant_settings	PATCH /v1/settings/tenant	Modify Tenant Settings

get_feature_flags¶

List[str] get_feature_flags()

Get Feature Flags

Get the feature flags enabled in the Security Cloud Control tenant.

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.TenantManagementApi(api_client)

    try:
        # Get Feature Flags
        api_response = api_instance.get_feature_flags()
        print("The response of TenantManagementApi->get_feature_flags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantManagementApi->get_feature_flags: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

List[str]

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	Set of feature flags that are enabled for the user's tenant.	-
401	Request not authorized.	-
500	Internal server error.	-

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

get_tenant¶

Tenant get_tenant(tenant_uid)

Get Tenant

Fetch a tenant by UID in Security Cloud Control. This will return a 200 response only if the user is associated with the tenant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.tenant import Tenant
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.TenantManagementApi(api_client)
    tenant_uid = 'tenant_uid_example' # str | The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.

    try:
        # Get Tenant
        api_response = api_instance.get_tenant(tenant_uid)
        print("The response of TenantManagementApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantManagementApi->get_tenant: %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¶

Tenant

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	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_tenant_settings¶

TenantSettings get_tenant_settings()

Get Tenant Settings

Get the settings for the Security Cloud Control tenant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.tenant_settings import TenantSettings
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.TenantManagementApi(api_client)

    try:
        # Get Tenant Settings
        api_response = api_instance.get_tenant_settings()
        print("The response of TenantManagementApi->get_tenant_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantManagementApi->get_tenant_settings: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

TenantSettings

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	Tenant Settings 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_tenants¶

TenantPage get_tenants(limit=limit, offset=offset)

Get Tenants

Get a list of tenants with which the Security Cloud Control user is associated. This endpoint must be called using the access token of a human user associated with a tenant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.tenant_page import TenantPage
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.TenantManagementApi(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')

    try:
        # Get Tenants
        api_response = api_instance.get_tenants(limit=limit, offset=offset)
        print("The response of TenantManagementApi->get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantManagementApi->get_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']

Return type¶

TenantPage

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

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

modify_tenant_settings¶

TenantSettings modify_tenant_settings(tenant_settings)

Modify Tenant Settings

Modify the settings for the Security Cloud Control tenant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.tenant_settings import TenantSettings
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.TenantManagementApi(api_client)
    tenant_settings = scc_firewall_manager_sdk.TenantSettings() # TenantSettings | 

    try:
        # Modify Tenant Settings
        api_response = api_instance.modify_tenant_settings(tenant_settings)
        print("The response of TenantManagementApi->modify_tenant_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantManagementApi->modify_tenant_settings: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_settings	TenantSettings

Return type¶

TenantSettings

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	Tenant Settings 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]