scc_firewall_manager_sdk.ObjectManagementApi¶

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
create_object	POST /v1/objects	Create Object
create_targets	POST /v1/objects/{uid}/targets	Create Targets
delete_object	DELETE /v1/objects/{uid}	Delete Object
get_duplicate_objects	GET /v1/objects/{uid}/duplicates	Get Duplicate Objects
get_issues_count	GET /v1/objects/issues-count	Get Issues Count
get_object	GET /v1/objects/{uid}	Get Object
get_object_usages	GET /v1/objects/{uid}/usage	Get Object Usages
get_objects	GET /v1/objects	Get Objects
get_override_object	GET /v1/objects/overrides/{uid}	Get Override Object With Values For Specific Target
get_targets	GET /v1/objects/{uid}/targets	Get Targets
modify_object	PATCH /v1/objects/{uid}	Modify Object

create_object¶

ObjectResponse create_object(create_request)

Create Object

Create an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.create_request import CreateRequest
from scc_firewall_manager_sdk.models.object_response import ObjectResponse
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.ObjectManagementApi(api_client)
    create_request = scc_firewall_manager_sdk.CreateRequest() # CreateRequest | 

    try:
        # Create Object
        api_response = api_instance.create_object(create_request)
        print("The response of ObjectManagementApi->create_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->create_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
create_request	CreateRequest

Return type¶

ObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
201	A descriptive representation of the created Security Cloud Control 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.	-
405	Method not allowed.	-
500	Internal server error.	-

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

create_targets¶

object create_targets(uid, targets_request)

Create Targets

Create targets for an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.targets_request import TargetsRequest
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | the unique identifier of the object for which the targets are being added to.
    targets_request = scc_firewall_manager_sdk.TargetsRequest() # TargetsRequest | 

    try:
        # Create Targets
        api_response = api_instance.create_targets(uid, targets_request)
        print("The response of ObjectManagementApi->create_targets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->create_targets: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	the unique identifier of the object for which the targets are being added to.
targets_request	TargetsRequest

Return type¶

object

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	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.	-
404	Not found	-
405	Method not allowed.	-
500	Internal server error.	-

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

delete_object¶

object delete_object(uid, forced_delete=forced_delete)

Delete Object

Delete an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object being deleted.
    forced_delete = False # bool | Force mode is required to delete an object that hasn't targets but is in use by another object. (optional) (default to False)

    try:
        # Delete Object
        api_response = api_instance.delete_object(uid, forced_delete=forced_delete)
        print("The response of ObjectManagementApi->delete_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->delete_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object being deleted.
forced_delete	bool	Force mode is required to delete an object that hasn't targets but is in use by another object.	[optional] [default to False]

Return type¶

object

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.	-
405	Method not allowed.	-
500	Internal server error.	-

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

get_duplicate_objects¶

List[DuplicateGroupDto] get_duplicate_objects(uid, target_uid)

Get Duplicate Objects

Get objects in the Security Cloud Control tenant that are duplicates of the given object. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.duplicate_group_dto import DuplicateGroupDto
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object to retrieve duplicates for.
    target_uid = '6131daad-e813-4b8f-8f42-be1e241e8cdb' # str | the unique identifier of the target to restrict the duplicate search to.

    try:
        # Get Duplicate Objects
        api_response = api_instance.get_duplicate_objects(uid, target_uid)
        print("The response of ObjectManagementApi->get_duplicate_objects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_duplicate_objects: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object to retrieve duplicates for.
target_uid	str	the unique identifier of the target to restrict the duplicate search to.

Return type¶

List[DuplicateGroupDto]

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	Duplicates of the 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.	-
405	Method not allowed.	-
500	Internal server error.	-

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

get_issues_count¶

IssuesCount get_issues_count(q=q)

Get Issues Count

Get issues count in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.issues_count import IssuesCount
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.ObjectManagementApi(api_client)
    q = 'content:*2.2.* AND name:Lab1' # str | The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are name, content. (optional)

    try:
        # Get Issues Count
        api_response = api_instance.get_issues_count(q=q)
        print("The response of ObjectManagementApi->get_issues_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_issues_count: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
q	str	The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are name, content.	[optional]

Return type¶

IssuesCount

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

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

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

get_object¶

ObjectResponse get_object(uid, fields=fields)

Get Object

Gets an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.object_response import ObjectResponse
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object being retrieved.
    fields = '@detailed' # str | The scope of the fields to be retrieved. One of [\"@basic\", \"@detailed\"]. Defaults to \"@basic\". (optional)

    try:
        # Get Object
        api_response = api_instance.get_object(uid, fields=fields)
        print("The response of ObjectManagementApi->get_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object being retrieved.
fields	str	The scope of the fields to be retrieved. One of [\"@basic\", \"@detailed\"]. Defaults to \"@basic\".	[optional]

Return type¶

ObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

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

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

get_object_usages¶

List[ReferenceInfo] get_object_usages(uid)

Get Object Usages

Get usages of an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.reference_info import ReferenceInfo
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object to retrieve usages for.

    try:
        # Get Object Usages
        api_response = api_instance.get_object_usages(uid)
        print("The response of ObjectManagementApi->get_object_usages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_object_usages: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object to retrieve usages for.

Return type¶

List[ReferenceInfo]

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	A descriptive representation of the created Security Cloud Control 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.	-
405	Method not allowed.	-
500	Internal server error.	-

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

get_objects¶

ListObjectResponse get_objects(q=q, include_overrides=include_overrides, offset=offset, limit=limit, sort_by=sort_by, sort=sort)

Get Objects

Get objects in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.list_object_response import ListObjectResponse
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.ObjectManagementApi(api_client)
    q = 'content:*2.2.* AND name:Lab1' # str | The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are name, content. (optional)
    include_overrides = False # bool | If enabled, the search will also include results from override objects. (optional) (default to False)
    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')
    limit = '50' # str | The number of results to retrieve. (optional) (default to '50')
    sort_by = 'name:DESC' # str | The fields to sort results by. This parameter is deprecated. (optional)
    sort = 'name:DESC' # str | The fields to sort results by. (optional)

    try:
        # Get Objects
        api_response = api_instance.get_objects(q=q, include_overrides=include_overrides, offset=offset, limit=limit, sort_by=sort_by, sort=sort)
        print("The response of ObjectManagementApi->get_objects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_objects: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
q	str	The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are name, content.	[optional]
include_overrides	bool	If enabled, the search will also include results from override objects.	[optional] [default to False]
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']
limit	str	The number of results to retrieve.	[optional] [default to '50']
sort_by	str	The fields to sort results by. This parameter is deprecated.	[optional]
sort	str	The fields to sort results by.	[optional]

Return type¶

ListObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	A paginated view of the Security Cloud Control 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.	-
405	Method not allowed.	-
500	Internal server error.	-

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

get_override_object¶

ObjectResponse get_override_object(uid, target_uid)

Get Override Object With Values For Specific Target

Gets an object in the Security Cloud Control tenant with values for specific target uid. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.object_response import ObjectResponse
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object being retrieved.
    target_uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The target UID to calculate values for.

    try:
        # Get Override Object With Values For Specific Target
        api_response = api_instance.get_override_object(uid, target_uid)
        print("The response of ObjectManagementApi->get_override_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_override_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object being retrieved.
target_uid	str	The target UID to calculate values for.

Return type¶

ObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

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

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

get_targets¶

ListObjectResponse get_targets(uid, q=q, offset=offset, limit=limit)

Get Targets

Get targets from an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.list_object_response import ListObjectResponse
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object for which the targets are being retrieved.
    q = 'targetType:MCD' # str | The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are: targetType. (optional)
    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')
    limit = '50' # str | The number of results to retrieve. (optional) (default to '50')

    try:
        # Get Targets
        api_response = api_instance.get_targets(uid, q=q, offset=offset, limit=limit)
        print("The response of ObjectManagementApi->get_targets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->get_targets: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object for which the targets are being retrieved.
q	str	The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are: targetType.	[optional]
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']
limit	str	The number of results to retrieve.	[optional] [default to '50']

Return type¶

ListObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	A paginated view of the Security Cloud Control targets.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
405	Method not allowed.	-
500	Internal server error.	-

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

modify_object¶

ObjectResponse modify_object(uid, update_request)

Modify Object

Modify an object in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.object_response import ObjectResponse
from scc_firewall_manager_sdk.models.update_request import UpdateRequest
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.ObjectManagementApi(api_client)
    uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | The unique identifier of the object being updated.
    update_request = scc_firewall_manager_sdk.UpdateRequest() # UpdateRequest | 

    try:
        # Modify Object
        api_response = api_instance.modify_object(uid, update_request)
        print("The response of ObjectManagementApi->modify_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectManagementApi->modify_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
uid	str	The unique identifier of the object being updated.
update_request	UpdateRequest

Return type¶

ObjectResponse

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
200	A descriptive representation of the updated Security Cloud Control 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.	-
405	Method not allowed.	-
500	Internal server error.	-

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