scc_firewall_manager_sdk.AccessGroupsApi

All URIs are relative to https://api.us.security.cisco.com/firewall

Method HTTP request Description
create_access_group POST /v1/policies/asa/accessgroups Create Access Group
delete_access_group DELETE /v1/policies/asa/accessgroups/{accessGroupUid} Delete Access Group
fetch_access_group GET /v1/policies/asa/accessgroups/{accessGroupUid} Get Access Group
list_access_groups GET /v1/policies/asa/accessgroups Get Access Groups
patch_access_group PATCH /v1/policies/asa/accessgroups/{accessGroupUid} Modify ASA Access Group

create_access_group

AccessGroup create_access_group(access_group_create_input)

Create Access Group

Create an Access Group

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.access_group import AccessGroup
from scc_firewall_manager_sdk.models.access_group_create_input import AccessGroupCreateInput
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.AccessGroupsApi(api_client)
    access_group_create_input = scc_firewall_manager_sdk.AccessGroupCreateInput() # AccessGroupCreateInput | 

    try:
        # Create Access Group
        api_response = api_instance.create_access_group(access_group_create_input)
        print("The response of AccessGroupsApi->create_access_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessGroupsApi->create_access_group: %s\n" % e)

Parameters

Name Type Description Notes
access_group_create_input AccessGroupCreateInput

Return type

AccessGroup

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Security Cloud Control Access Group -
400 Invalid input provided. Check the response for details. -
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]

delete_access_group

delete_access_group(access_group_uid)

Delete Access Group

Delete Access Group by UID 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.AccessGroupsApi(api_client)
    access_group_uid = 'access_group_uid_example' # str | The unique identifier, represented as a UUID, of the Access Group in Security Cloud Control.

    try:
        # Delete Access Group
        api_instance.delete_access_group(access_group_uid)
    except Exception as e:
        print("Exception when calling AccessGroupsApi->delete_access_group: %s\n" % e)

Parameters

Name Type Description Notes
access_group_uid str The unique identifier, represented as a UUID, of the Access Group 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. -
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]

fetch_access_group

AccessGroup fetch_access_group(access_group_uid)

Get Access Group

Get a single ASA Access Group by UUID.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.access_group import AccessGroup
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.AccessGroupsApi(api_client)
    access_group_uid = 'access_group_uid_example' # str | The unique identifier, represented as a UUID, of the Access Group in Security Cloud Control.

    try:
        # Get Access Group
        api_response = api_instance.fetch_access_group(access_group_uid)
        print("The response of AccessGroupsApi->fetch_access_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessGroupsApi->fetch_access_group: %s\n" % e)

Parameters

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

Return type

AccessGroup

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Access Group object -
400 Invalid input provided. Check the response for details. -
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]

list_access_groups

AccessGroupPage list_access_groups(limit=limit, offset=offset, q=q, sort=sort)

Get Access Groups

Get a list of ASA Access Groups.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.access_group_page import AccessGroupPage
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.AccessGroupsApi(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)
    sort = ['name:DESC'] # List[str] | The fields to sort results by. (optional)

    try:
        # Get Access Groups
        api_response = api_instance.list_access_groups(limit=limit, offset=offset, q=q, sort=sort)
        print("The response of AccessGroupsApi->list_access_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessGroupsApi->list_access_groups: %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]
sort List[str] The fields to sort results by. [optional]

Return type

AccessGroupPage

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 List of Access Groups -
400 Invalid input provided. Check the response for details. -
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]

patch_access_group

AccessGroup patch_access_group(access_group_uid, access_group_update_input)

Modify ASA Access Group

Modify Security Cloud Control Access Group by UID.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.access_group import AccessGroup
from scc_firewall_manager_sdk.models.access_group_update_input import AccessGroupUpdateInput
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.AccessGroupsApi(api_client)
    access_group_uid = 'access_group_uid_example' # str | The unique identifier, represented as a UUID, of the Security Cloud Control Access Group.
    access_group_update_input = scc_firewall_manager_sdk.AccessGroupUpdateInput() # AccessGroupUpdateInput | 

    try:
        # Modify ASA Access Group
        api_response = api_instance.patch_access_group(access_group_uid, access_group_update_input)
        print("The response of AccessGroupsApi->patch_access_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessGroupsApi->patch_access_group: %s\n" % e)

Parameters

Name Type Description Notes
access_group_uid str The unique identifier, represented as a UUID, of the Security Cloud Control Access Group.
access_group_update_input AccessGroupUpdateInput

Return type

AccessGroup

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Security Cloud Control Access Group -
400 Invalid input provided. Check the response for details. -
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]