scc_firewall_manager_sdk.MetaApi¶

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_jwks	GET /.well-known/jwks.json	Fetch JSON Web Key Set
get_meta	GET /v1/meta	Get Meta information
get_regions	GET /v1/regions	Get Security Cloud Control Regions

get_jwks¶

JwkSet get_jwks()

Fetch JSON Web Key Set

Retrieves the JSON Web Key Set (JWKS), which is a set of keys containing the public keys used to verify any JSON Web Token (JWT) issued by the Authorization Server and signed using the RS256 signing algorithm. Note: Verification of the token using a JSON Web Key does not guarantee validity due to the possibility of revocation.

Example¶

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.jwk_set import JwkSet
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"
)


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

    try:
        # Fetch JSON Web Key Set
        api_response = api_instance.get_jwks()
        print("The response of MetaApi->get_jwks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaApi->get_jwks: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

JwkSet

Authorization¶

No authorization required

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	The JSON Web Key Set.	-
500	Internal server error.	-

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

get_meta¶

Meta get_meta()

Get Meta information

Get Meta information about CDO, including the IP addresses of Security Cloud Control services.

Example¶

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.meta import Meta
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"
)


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

    try:
        # Get Meta information
        api_response = api_instance.get_meta()
        print("The response of MetaApi->get_meta:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaApi->get_meta: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

Meta

Authorization¶

No authorization required

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	Meta information about Security Cloud Control.	-
500	Internal server error.	-

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

get_regions¶

CdoRegionList get_regions()

Get Security Cloud Control Regions

Get the list of regions that Security Cloud Control is deployed in.

Example¶

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_region_list import CdoRegionList
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"
)


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

    try:
        # Get Security Cloud Control Regions
        api_response = api_instance.get_regions()
        print("The response of MetaApi->get_regions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaApi->get_regions: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

CdoRegionList

Authorization¶

No authorization required

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	List of Security Cloud Control regions	-
500	Internal server error.	-

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