scc_firewall_manager_sdk.RemoteAccessMonitoringApi

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_mfa_event GET /v1/mfaevents/{mfaEventUid} Get MFA Event
get_mfa_events GET /v1/mfaevents Get MFA Events
get_ra_vpn_session GET /v1/vpnsessions/{raVpnSessionUid} Get RA VPN Session
get_ra_vpn_sessions GET /v1/vpnsessions Get RA VPN Sessions
refresh_ra_vpn_sessions_by_device POST /v1/vpnsessions/refresh Refresh RA VPN Sessions
terminate_ra_vpn_sessions_by_device POST /v1/vpnsessions/{deviceUid}/terminate Terminate RA VPN Sessions
terminate_ra_vpn_sessions_by_device_and_user_name POST /v1/vpnsessions/{deviceUid}/terminate/{userName} Terminate User's RA VPN Sessions

get_mfa_event

MfaEvent get_mfa_event(mfa_event_uid)

Get MFA Event

Get a MFA event by UID in the Security Cloud Control tenant.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.mfa_event import MfaEvent
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.RemoteAccessMonitoringApi(api_client)
    mfa_event_uid = 'mfa_event_uid_example' # str | The unique identifier, represented as a UUID, of the MFA event in Security Cloud Control.

    try:
        # Get MFA Event
        api_response = api_instance.get_mfa_event(mfa_event_uid)
        print("The response of RemoteAccessMonitoringApi->get_mfa_event:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->get_mfa_event: %s\n" % e)

Parameters

Name Type Description Notes
mfa_event_uid str The unique identifier, represented as a UUID, of the MFA event in Security Cloud Control.

Return type

MfaEvent

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

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

get_mfa_events

MfaEventPage get_mfa_events(limit=limit, offset=offset, q=q, sort=sort)

Get MFA Events

Get a list of MFA events.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.mfa_event_page import MfaEventPage
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.RemoteAccessMonitoringApi(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')
    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 MFA Events
        api_response = api_instance.get_mfa_events(limit=limit, offset=offset, q=q, sort=sort)
        print("The response of RemoteAccessMonitoringApi->get_mfa_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->get_mfa_events: %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']
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

MfaEventPage

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

RaVpnSession get_ra_vpn_session(ra_vpn_session_uid)

Get RA VPN Session

Get a RA VPN session by UID in the Security Cloud Control tenant.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ra_vpn_session import RaVpnSession
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.RemoteAccessMonitoringApi(api_client)
    ra_vpn_session_uid = 'ra_vpn_session_uid_example' # str | The unique identifier, represented as a UUID, of the RA VPN session in Security Cloud Control.

    try:
        # Get RA VPN Session
        api_response = api_instance.get_ra_vpn_session(ra_vpn_session_uid)
        print("The response of RemoteAccessMonitoringApi->get_ra_vpn_session:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->get_ra_vpn_session: %s\n" % e)

Parameters

Name Type Description Notes
ra_vpn_session_uid str The unique identifier, represented as a UUID, of the RA VPN session in Security Cloud Control.

Return type

RaVpnSession

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 RA VPN Session 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. -
405 Method not allowed. -
500 Internal server error. -

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

get_ra_vpn_sessions

RaVpnSessionPage get_ra_vpn_sessions(limit=limit, offset=offset, q=q, sort=sort)

Get RA VPN Sessions

Get a list of RA VPN sessions.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ra_vpn_session_page import RaVpnSessionPage
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.RemoteAccessMonitoringApi(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')
    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 RA VPN Sessions
        api_response = api_instance.get_ra_vpn_sessions(limit=limit, offset=offset, q=q, sort=sort)
        print("The response of RemoteAccessMonitoringApi->get_ra_vpn_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->get_ra_vpn_sessions: %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']
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

RaVpnSessionPage

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

refresh_ra_vpn_sessions_by_device

CdoTransaction refresh_ra_vpn_sessions_by_device(ra_vpn_device_input=ra_vpn_device_input)

Refresh RA VPN Sessions

This is an asynchronous operation to refresh RA VPN sessions for all devices in the Security Cloud Control tenant.

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.ra_vpn_device_input import RaVpnDeviceInput
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.RemoteAccessMonitoringApi(api_client)
    ra_vpn_device_input = scc_firewall_manager_sdk.RaVpnDeviceInput() # RaVpnDeviceInput |  (optional)

    try:
        # Refresh RA VPN Sessions
        api_response = api_instance.refresh_ra_vpn_sessions_by_device(ra_vpn_device_input=ra_vpn_device_input)
        print("The response of RemoteAccessMonitoringApi->refresh_ra_vpn_sessions_by_device:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->refresh_ra_vpn_sessions_by_device: %s\n" % e)

Parameters

Name Type Description Notes
ra_vpn_device_input RaVpnDeviceInput [optional]

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

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

terminate_ra_vpn_sessions_by_device

CdoTransaction terminate_ra_vpn_sessions_by_device(device_uid)

Terminate RA VPN Sessions

This is an asynchronous operation to terminate all RA VPN sessions on a device in the Security Cloud Control tenant. This operation returns a link to a transaction object that can be used to monitor the progress of the operation.

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.RemoteAccessMonitoringApi(api_client)
    device_uid = 'device_uid_example' # str | 

    try:
        # Terminate RA VPN Sessions
        api_response = api_instance.terminate_ra_vpn_sessions_by_device(device_uid)
        print("The response of RemoteAccessMonitoringApi->terminate_ra_vpn_sessions_by_device:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->terminate_ra_vpn_sessions_by_device: %s\n" % e)

Parameters

Name Type Description Notes
device_uid str

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

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

terminate_ra_vpn_sessions_by_device_and_user_name

CdoTransaction terminate_ra_vpn_sessions_by_device_and_user_name(device_uid, user_name)

Terminate User's RA VPN Sessions

This is an asynchronous operation to terminate all of a user's RA VPN sessions on a device in the Security Cloud Control tenant. This operation returns a link to a transaction object that can be used to monitor the progress of the operation.

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.RemoteAccessMonitoringApi(api_client)
    device_uid = 'device_uid_example' # str | 
    user_name = 'user_name_example' # str | 

    try:
        # Terminate User's RA VPN Sessions
        api_response = api_instance.terminate_ra_vpn_sessions_by_device_and_user_name(device_uid, user_name)
        print("The response of RemoteAccessMonitoringApi->terminate_ra_vpn_sessions_by_device_and_user_name:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteAccessMonitoringApi->terminate_ra_vpn_sessions_by_device_and_user_name: %s\n" % e)

Parameters

Name Type Description Notes
device_uid str
user_name str

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

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