# -*- coding: utf-8 -*-
"""Cisco Identity Services Engine AllowedProtocols API wrapper.
Copyright (c) 2021 Cisco and/or its affiliates.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from __future__ import absolute_import, division, print_function, unicode_literals
from builtins import *
from past.builtins import basestring
from ...pagination import get_next_page
from ...restsession import RestSession
from ...utils import (
apply_path_params,
check_type,
dict_from_items_with_values,
dict_of_str,
)
[docs]class AllowedProtocols(object):
"""Identity Services Engine AllowedProtocols API (version: 3.1.0).
Wraps the Identity Services Engine AllowedProtocols
API and exposes the API as native Python
methods that return native Python objects.
| Allowed Protocols API allows the client to add, delete, update, search and perform actions on allowed protocols.
**Revision History**
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| Revision # | Resource Version | Cisco ISE Version | Description | Revision Modification | Revision Modification |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | Attribute | Description |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| 0 | 1.0 | 2.3 | Initial Cisco ISE Version | | |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| 1 | 1.1 | 2.7 | Added support for TEAP | preferredEapProtocol | Added value 'TEAP' to enum attribute preferredEapProtocol |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | allowTeap | Added boolean attribute allowTeap |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | allowTeapEapMsChapV2 | Added boolean attribute allowTeapEapMsChapV2 |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | allowTeapEapMsChapV2PwdChange | Added boolean attribute allowTeap |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | allowTeapEapMsChapV2PwdChangeRetries | Added int attribute allowTeapEapMsChapV2PwdChangeRetries |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
| | | | | allowTeapEapTls | Added boolean attribute allowTeapEapTls |
+------------+--------------------+-------------------+---------------------------+--------------------------------------+-------------------------------------------------------------+
|
**Resource Definition**
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| **Attribute** | **Type** | **Required** | **Description** | **Example Values** |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| name | String | Yes | Resource Name | Default Device Admin |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| id | String | No | Resource UUID, Mandatory for update | 926901b0-8c01-11e6-996c-525400b48521 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| description | String | No | | Default Allowed Protocol Service Device Admin |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| processHostLookup | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowPapAscii | Boolean | No | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowChap | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowMsChapV1 | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowMsChapV2 | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowEapMd5 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowLeap | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowEapTls | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowEapTtls | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowEapFast | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowPeap | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowTeap | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowPreferredEapProtocol | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| eapTlsLBit | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| allowWeakCiphersForEap | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| requireMessageAuth | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| preferredEapProtocol | Enum | No | The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored. | PEAP |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| eapTls | List | No | The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapTlsAuthOfExpiredCerts | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTlsEnableStatelessSessionResume | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTlsSessionTicketTtl | Integer | No | Time to live. The eapTlsSessionTicketTtl is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTlsSessionTicketTtlUnits | Enum | No | Time to live time units. The eapTlsSessionTicketTtlUnits is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored. | SECONDS |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTlsSessionTicketPrecentage | Integer | No | The eapTlsSessionTicketPrecentage is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| peap | List | No | The peap is required only if allowPeap is true, otherwise it must be ignored. The object peap contains the settings for PEAP protocol | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapMsChapV2 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapMsChapV2PwdChange | Boolean | No | The allowPeapEapMsChapV2PwdChange is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapMsChapV2PwdChangeRetries | Integer | No | The allowPeapEapMsChapV2PwdChangeRetries is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3 | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapGtc | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapGtcPwdChange | Boolean | No | The allowPeapEapGtcPwdChange is required only if allowPeapEapGtc is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapGtcPwdChangeRetries | Integer | No | The allowPeapEapGtcPwdChangeRetries is required only if allowPeapEapGtc is true, otherwise it must be ignored. Valid range is 0-3 | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapTls | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapEapTlsAuthOfExpiredCerts | Boolean | No | The allowPeapEapTlsAuthOfExpiredCerts is required only if allowPeapEapTls is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - requireCryptobinding | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowPeapV0 | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| eapTtls | List | No | The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsPapAscii | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsChap | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsMsChapV1 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsMsChapV2 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsEapMd5 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsEapMsChapV2 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsEapMsChapV2PwdChange | Boolean | No | The eapTtlsEapMsChapV2PwdChange is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapTtlsEapMsChapV2PwdChangeRetries | Integer | No | The eapTtlsEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3 | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| eapFast | List | No | The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapMsChapV2 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapMsChapV2PwdChange | Boolean | No | The allowEapFastEapMsChapV2PwdChange is required only if allowEapFastEapMsChapV2 is true, otherwise it must be ignored | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapMsChapV2PwdChangeRetries | Integer | No | The allowEapFastEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3 | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapGtc | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapGtcPwdChange | Boolean | No | The allowEapFastEapGtcPwdChange is required only if allowEapFastEapGtc is true, otherwise it must be ignored | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapGtcPwdChangeRetries | Integer | No | The allowEapFastEapGtcPwdChangeRetries is required only if allowEapFastEapGtc is true, otherwise it must be ignored. Valid range is 0-3 | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapTls | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowEapFastEapTlsAuthOfExpiredCerts | Boolean | No | The allowEapFastEapTlsAuthOfExpiredCerts is required only if allowEapFastEapTls is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastEnableEAPChaining | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacs | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsTunnelPacTtl | Integer | No | The eapFastUsePacsTunnelPacTtl is required only if eapFastUsePacs is true, otherwise it must be ignored | 7776000 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsTunnelPacTtlUnits | Enum | No | The eapFastUsePacsTunnelPacTtlUnits is required only if eapFastUsePacs is true, otherwise it must be ignored. | SECONDS |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsUseProactivePacUpdatePrecentage | Integer | No | The eapFastUsePacsUseProactivePacUpdatePrecentage is required only if eapFastUsePacs is true, otherwise it must be ignored | 10 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAllowAnonymProvisioning | Boolean | No | The eapFastUsePacsAllowAnonymProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAllowAuthenProvisioning | Boolean | No | The eapFastUsePacsAllowAuthenProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsReturnAccessAccept | Boolean | No | The eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored | false |
| AfterAuthenticatedProvisioning | | | | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAcceptClientCert | Boolean | No | The eapFastUsePacsAcceptClientCert is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAllowMachineAuthentication | Boolean | No | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsMachinePacTtl | Integer | No | The eapFastUsePacsMachinePacTtl is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsMachinePacTtlUnits | Enum | No | The eapFastUsePacsMachinePacTtlUnits is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored. | SECONDS |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsStatelessSessionResume | Boolean | No | The eapFastUsePacsStatelessSessionResume is required only if eapFastUsePacs is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAuthorizationPacTtl | Integer | No | The eapFastUsePacsAuthorizationPacTtl is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored | 1 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastUsePacsAuthorizationPacTtlUnits | Enum | No | The eapFastUsePacsAuthorizationPacTtlUnits is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored. | SECONDS |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastDontUsePacsAcceptClientCert | Boolean | No | The eapFastDontUsePacsAcceptClientCert is required only if eapFastUsePacs is FALSE, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - eapFastDontUsePacsAllowMachineAuthentication | Boolean | No | The eapFastDontUsePacsAllowMachineAuthentication is required only if eapFastUsePacs is FALSE, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| teap | List | No | The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol | |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowTeapEapMsChapV2 | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowTeapEapMsChapV2PwdChange | Boolean | No | The allowTeapEapMsChapV2PwdChange is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowTeapEapMsChapV2PwdChangeRetries | Integer | No | The allowTeapEapMsChapV2PwdChangeRetries is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3 | 3 |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowTeapEapTls | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowTeapEapTlsAuthOfExpiredCerts | Boolean | No | The allowTeapEapTlsAuthOfExpiredCerts is required only if allowTeapEapTls is true, otherwise it must be ignored | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - acceptClientCertDuringTunnelEst | Boolean | Yes | | true |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - enableEapChaining | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
| - allowDowngradeMsk | Boolean | Yes | | false |
+-------------------------------------------------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
"""
def __init__(self, session, object_factory, request_validator):
"""Initialize a new AllowedProtocols
object with the provided RestSession.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the Identity Services Engine service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(AllowedProtocols, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def get_allowed_protocol_by_name(self,
name,
headers=None,
**query_parameters):
"""This API allows the client to get an allowed protocol by name.
Args:
name(basestring): name path parameter.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(name, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'name': name,
}
e_url = ('/ers/config/allowedprotocols/name/{name}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_ac8c8cb9b5007a1e1a6434a20a881_v3_1_0', _api_response)
[docs] def get_by_name(self,
name,
headers=None,
**query_parameters):
"""Alias for `get_allowed_protocol_by_name <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.get_allowed_protocol_by_name>`_
"""
return self.get_allowed_protocol_by_name(
name=name,
headers=headers,
**query_parameters
)
[docs] def get_allowed_protocol_by_id(self,
id,
headers=None,
**query_parameters):
"""This API allows the client to get an allowed protocol by ID.
Args:
id(basestring): id path parameter.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'id': id,
}
e_url = ('/ers/config/allowedprotocols/{id}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_e3ddfddd45e299f14ed194926f8de_v3_1_0', _api_response)
[docs] def get_by_id(self,
id,
headers=None,
**query_parameters):
"""Alias for `get_allowed_protocol_by_id <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.get_allowed_protocol_by_id>`_
"""
return self.get_allowed_protocol_by_id(
id=id,
headers=headers,
**query_parameters
)
[docs] def update_allowed_protocol_by_id(self,
id,
allow_chap=None,
allow_eap_fast=None,
allow_eap_md5=None,
allow_eap_tls=None,
allow_eap_ttls=None,
allow_leap=None,
allow_ms_chap_v1=None,
allow_ms_chap_v2=None,
allow_pap_ascii=None,
allow_peap=None,
allow_preferred_eap_protocol=None,
allow_teap=None,
allow_weak_ciphers_for_eap=None,
description=None,
eap_fast=None,
eap_tls=None,
eap_tls_l_bit=None,
eap_ttls=None,
name=None,
peap=None,
preferred_eap_protocol=None,
process_host_lookup=None,
require_message_auth=None,
teap=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""This API allows the client to update an allowed protocol.
Args:
allow_chap(boolean): allowChap, property of the request
body.
allow_eap_fast(boolean): allowEapFast, property of the
request body.
allow_eap_md5(boolean): allowEapMd5, property of the
request body.
allow_eap_tls(boolean): allowEapTls, property of the
request body.
allow_eap_ttls(boolean): allowEapTtls, property of the
request body.
allow_leap(boolean): allowLeap, property of the request
body.
allow_ms_chap_v1(boolean): allowMsChapV1, property of
the request body.
allow_ms_chap_v2(boolean): allowMsChapV2, property of
the request body.
allow_pap_ascii(boolean): allowPapAscii, property of the
request body.
allow_peap(boolean): allowPeap, property of the request
body.
allow_preferred_eap_protocol(boolean):
allowPreferredEapProtocol, property of
the request body.
allow_teap(boolean): allowTeap, property of the request
body.
allow_weak_ciphers_for_eap(boolean):
allowWeakCiphersForEap, property of the
request body.
description(string): description, property of the
request body.
eap_fast(object): The eapFast is required only if
allowEapFast is true, otherwise it must
be ignored. The object eapFast contains
the settings for EAP FAST protocol,
property of the request body.
eap_tls(object): The eapTls is required only if
allowEapTls is true, otherwise it must
be ignored. The object eapTls contains
the settings for EAP TLS protocol,
property of the request body.
eap_tls_l_bit(boolean): eapTlsLBit, property of the
request body.
eap_ttls(object): The eapTtls is required only if
allowEapTtls is true, otherwise it must
be ignored. The object eapTtls contains
the settings for EAP TTLS protocol,
property of the request body.
id(string): Resource UUID, Mandatory for update,
property of the request body.
name(string): Resource Name, property of the request
body.
peap(object): peap, property of the request body.
preferred_eap_protocol(string): The preferredEapProtocol
is required only if
allowPreferredEapProtocol is true,
otherwise it must be ignored. Allowed
Values: EAP_FAST, PEAP, LEAP, EAP_MD5,
EAP_TLS, EAP_TTLS, TEAP, property of the
request body.
process_host_lookup(boolean): processHostLookup,
property of the request body.
require_message_auth(boolean): requireMessageAuth,
property of the request body.
teap(object): The teap is required only if allowTeap is
true, otherwise it must be ignored. The
object teap contains the settings for
TEAP protocol, property of the request
body.
id(basestring): id path parameter.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
if active_validation and is_xml_payload:
check_type(payload, basestring)
if active_validation and not is_xml_payload:
check_type(payload, dict)
check_type(id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'id': id,
}
if is_xml_payload:
_payload = payload
else:
_tmp_payload = {
'id':
id,
'name':
name,
'description':
description,
'eapTls':
eap_tls,
'peap':
peap,
'eapFast':
eap_fast,
'eapTtls':
eap_ttls,
'teap':
teap,
'processHostLookup':
process_host_lookup,
'allowPapAscii':
allow_pap_ascii,
'allowChap':
allow_chap,
'allowMsChapV1':
allow_ms_chap_v1,
'allowMsChapV2':
allow_ms_chap_v2,
'allowEapMd5':
allow_eap_md5,
'allowLeap':
allow_leap,
'allowEapTls':
allow_eap_tls,
'allowEapTtls':
allow_eap_ttls,
'allowEapFast':
allow_eap_fast,
'allowPeap':
allow_peap,
'allowTeap':
allow_teap,
'allowPreferredEapProtocol':
allow_preferred_eap_protocol,
'preferredEapProtocol':
preferred_eap_protocol,
'eapTlsLBit':
eap_tls_l_bit,
'allowWeakCiphersForEap':
allow_weak_ciphers_for_eap,
'requireMessageAuth':
require_message_auth,
}
_payload = {
'AllowedProtocols': dict_from_items_with_values(_tmp_payload)
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_a0b312f70257b1bfa90d0260f0c971_v3_1_0')\
.validate(_payload)
e_url = ('/ers/config/allowedprotocols/{id}')
endpoint_full_url = apply_path_params(e_url, path_params)
request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
if with_custom_headers:
_api_response = self._session.put(endpoint_full_url, params=_params,
headers=_headers,
**request_params)
else:
_api_response = self._session.put(endpoint_full_url, params=_params,
**request_params)
return self._object_factory('bpm_a0b312f70257b1bfa90d0260f0c971_v3_1_0', _api_response)
[docs] def update_by_id(self,
id,
allow_chap=None,
allow_eap_fast=None,
allow_eap_md5=None,
allow_eap_tls=None,
allow_eap_ttls=None,
allow_leap=None,
allow_ms_chap_v1=None,
allow_ms_chap_v2=None,
allow_pap_ascii=None,
allow_peap=None,
allow_preferred_eap_protocol=None,
allow_teap=None,
allow_weak_ciphers_for_eap=None,
description=None,
eap_fast=None,
eap_tls=None,
eap_tls_l_bit=None,
eap_ttls=None,
name=None,
peap=None,
preferred_eap_protocol=None,
process_host_lookup=None,
require_message_auth=None,
teap=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Alias for `update_allowed_protocol_by_id <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.update_allowed_protocol_by_id>`_
"""
return self.update_allowed_protocol_by_id(
id=id,
allow_chap=allow_chap,
allow_eap_fast=allow_eap_fast,
allow_eap_md5=allow_eap_md5,
allow_eap_tls=allow_eap_tls,
allow_eap_ttls=allow_eap_ttls,
allow_leap=allow_leap,
allow_ms_chap_v1=allow_ms_chap_v1,
allow_ms_chap_v2=allow_ms_chap_v2,
allow_pap_ascii=allow_pap_ascii,
allow_peap=allow_peap,
allow_preferred_eap_protocol=allow_preferred_eap_protocol,
allow_teap=allow_teap,
allow_weak_ciphers_for_eap=allow_weak_ciphers_for_eap,
description=description,
eap_fast=eap_fast,
eap_tls=eap_tls,
eap_tls_l_bit=eap_tls_l_bit,
eap_ttls=eap_ttls,
name=name,
peap=peap,
preferred_eap_protocol=preferred_eap_protocol,
process_host_lookup=process_host_lookup,
require_message_auth=require_message_auth,
teap=teap,
payload=payload,
active_validation=active_validation,
headers=headers,
**query_parameters
)
[docs] def delete_allowed_protocol_by_id(self,
id,
headers=None,
**query_parameters):
"""This API deletes an allowed protocol.
Args:
id(basestring): id path parameter.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'id': id,
}
e_url = ('/ers/config/allowedprotocols/{id}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_a6cbd2c420785cfcbdecc3495bca8af4_v3_1_0', _api_response)
[docs] def delete_by_id(self,
id,
headers=None,
**query_parameters):
"""Alias for `delete_allowed_protocol_by_id <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.delete_allowed_protocol_by_id>`_
"""
return self.delete_allowed_protocol_by_id(
id=id,
headers=headers,
**query_parameters
)
[docs] def get_allowed_protocols(self,
page=None,
size=None,
headers=None,
**query_parameters):
"""This API allows the client to get all the allowed protocols.
Args:
page(int): page query parameter. Page number.
size(int): size query parameter. Number of objects
returned per page.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(page, (int, basestring, list))
check_type(size, (int, basestring, list))
_params = {
'page':
page,
'size':
size,
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
e_url = ('/ers/config/allowedprotocols')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_d82fe0f9e4635b74af809beaaf98bd07_v3_1_0', _api_response)
[docs] def get_all(self,
page=None,
size=None,
headers=None,
**query_parameters):
"""Alias for `get_allowed_protocols <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.get_allowed_protocols>`_
"""
return self.get_allowed_protocols(
page=page,
size=size,
headers=headers,
**query_parameters
)
[docs] def get_allowed_protocols_generator(self,
page=None,
size=None,
headers=None,
**query_parameters):
"""This API allows the client to get all the allowed protocols.
Args:
page(int): page query parameter. Page number.
size(int): size query parameter. Number of objects
returned per page.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
Generator: A generator object containing the following object.
+ RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
yield from get_next_page(
self.get_allowed_protocols, dict(
page=page,
size=size,
headers=headers,
**query_parameters
),
access_next_list=["SearchResult", "nextPage", "href"],
access_resource_list=["SearchResult", "resources"])
[docs] def get_all_generator(self,
page=None,
size=None,
headers=None,
**query_parameters):
"""Alias for `get_allowed_protocols_generator <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.get_allowed_protocols_generator>`_
"""
yield from get_next_page(
self.get_allowed_protocols, dict(
page=page,
size=size,
headers=headers,
**query_parameters
),
access_next_list=["SearchResult", "nextPage", "href"],
access_resource_list=["SearchResult", "resources"])
[docs] def create_allowed_protocol(self,
allow_chap=None,
allow_eap_fast=None,
allow_eap_md5=None,
allow_eap_tls=None,
allow_eap_ttls=None,
allow_leap=None,
allow_ms_chap_v1=None,
allow_ms_chap_v2=None,
allow_pap_ascii=None,
allow_peap=None,
allow_preferred_eap_protocol=None,
allow_teap=None,
allow_weak_ciphers_for_eap=None,
description=None,
eap_fast=None,
eap_tls=None,
eap_tls_l_bit=None,
eap_ttls=None,
name=None,
peap=None,
preferred_eap_protocol=None,
process_host_lookup=None,
require_message_auth=None,
teap=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""This API creates an allowed protocol.
Args:
allow_chap(boolean): allowChap, property of the request
body.
allow_eap_fast(boolean): allowEapFast, property of the
request body.
allow_eap_md5(boolean): allowEapMd5, property of the
request body.
allow_eap_tls(boolean): allowEapTls, property of the
request body.
allow_eap_ttls(boolean): allowEapTtls, property of the
request body.
allow_leap(boolean): allowLeap, property of the request
body.
allow_ms_chap_v1(boolean): allowMsChapV1, property of
the request body.
allow_ms_chap_v2(boolean): allowMsChapV2, property of
the request body.
allow_pap_ascii(boolean): allowPapAscii, property of the
request body.
allow_peap(boolean): allowPeap, property of the request
body.
allow_preferred_eap_protocol(boolean):
allowPreferredEapProtocol, property of
the request body.
allow_teap(boolean): allowTeap, property of the request
body.
allow_weak_ciphers_for_eap(boolean):
allowWeakCiphersForEap, property of the
request body.
description(string): description, property of the
request body.
eap_fast(object): The eapFast is required only if
allowEapFast is true, otherwise it must
be ignored. The object eapFast contains
the settings for EAP FAST protocol,
property of the request body.
eap_tls(object): The eapTls is required only if
allowEapTls is true, otherwise it must
be ignored. The object eapTls contains
the settings for EAP TLS protocol,
property of the request body.
eap_tls_l_bit(boolean): eapTlsLBit, property of the
request body.
eap_ttls(object): The eapTtls is required only if
allowEapTtls is true, otherwise it must
be ignored. The object eapTtls contains
the settings for EAP TTLS protocol,
property of the request body.
name(string): Resource Name, property of the request
body.
peap(object): peap, property of the request body.
preferred_eap_protocol(string): The preferredEapProtocol
is required only if
allowPreferredEapProtocol is true,
otherwise it must be ignored. Allowed
Values: EAP_FAST, PEAP, LEAP, EAP_MD5,
EAP_TLS, EAP_TTLS, TEAP, property of the
request body.
process_host_lookup(boolean): processHostLookup,
property of the request body.
require_message_auth(boolean): requireMessageAuth,
property of the request body.
teap(object): The teap is required only if allowTeap is
true, otherwise it must be ignored. The
object teap contains the settings for
TEAP protocol, property of the request
body.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
if 'ERS-Media-Type' in headers:
check_type(headers.get('ERS-Media-Type'),
basestring)
if 'X-CSRF-Token' in headers:
check_type(headers.get('X-CSRF-Token'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
if active_validation and is_xml_payload:
check_type(payload, basestring)
if active_validation and not is_xml_payload:
check_type(payload, dict)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
if is_xml_payload:
_payload = payload
else:
_tmp_payload = {
'name':
name,
'description':
description,
'eapTls':
eap_tls,
'peap':
peap,
'eapFast':
eap_fast,
'eapTtls':
eap_ttls,
'teap':
teap,
'processHostLookup':
process_host_lookup,
'allowPapAscii':
allow_pap_ascii,
'allowChap':
allow_chap,
'allowMsChapV1':
allow_ms_chap_v1,
'allowMsChapV2':
allow_ms_chap_v2,
'allowEapMd5':
allow_eap_md5,
'allowLeap':
allow_leap,
'allowEapTls':
allow_eap_tls,
'allowEapTtls':
allow_eap_ttls,
'allowEapFast':
allow_eap_fast,
'allowPeap':
allow_peap,
'allowTeap':
allow_teap,
'allowPreferredEapProtocol':
allow_preferred_eap_protocol,
'preferredEapProtocol':
preferred_eap_protocol,
'eapTlsLBit':
eap_tls_l_bit,
'allowWeakCiphersForEap':
allow_weak_ciphers_for_eap,
'requireMessageAuth':
require_message_auth,
}
_payload = {
'AllowedProtocols': dict_from_items_with_values(_tmp_payload)
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_b40ad23ab0a5a7b8adade320c8912e7_v3_1_0')\
.validate(_payload)
e_url = ('/ers/config/allowedprotocols')
endpoint_full_url = apply_path_params(e_url, path_params)
request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
if with_custom_headers:
_api_response = self._session.post(endpoint_full_url, params=_params,
headers=_headers,
**request_params)
else:
_api_response = self._session.post(endpoint_full_url, params=_params,
**request_params)
return self._object_factory('bpm_b40ad23ab0a5a7b8adade320c8912e7_v3_1_0', _api_response)
[docs] def create(self,
allow_chap=None,
allow_eap_fast=None,
allow_eap_md5=None,
allow_eap_tls=None,
allow_eap_ttls=None,
allow_leap=None,
allow_ms_chap_v1=None,
allow_ms_chap_v2=None,
allow_pap_ascii=None,
allow_peap=None,
allow_preferred_eap_protocol=None,
allow_teap=None,
allow_weak_ciphers_for_eap=None,
description=None,
eap_fast=None,
eap_tls=None,
eap_tls_l_bit=None,
eap_ttls=None,
name=None,
peap=None,
preferred_eap_protocol=None,
process_host_lookup=None,
require_message_auth=None,
teap=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Alias for `create_allowed_protocol <#ciscoisesdk.
api.v3_1_0.allowed_protocols.
AllowedProtocols.create_allowed_protocol>`_
"""
return self.create_allowed_protocol(
allow_chap=allow_chap,
allow_eap_fast=allow_eap_fast,
allow_eap_md5=allow_eap_md5,
allow_eap_tls=allow_eap_tls,
allow_eap_ttls=allow_eap_ttls,
allow_leap=allow_leap,
allow_ms_chap_v1=allow_ms_chap_v1,
allow_ms_chap_v2=allow_ms_chap_v2,
allow_pap_ascii=allow_pap_ascii,
allow_peap=allow_peap,
allow_preferred_eap_protocol=allow_preferred_eap_protocol,
allow_teap=allow_teap,
allow_weak_ciphers_for_eap=allow_weak_ciphers_for_eap,
description=description,
eap_fast=eap_fast,
eap_tls=eap_tls,
eap_tls_l_bit=eap_tls_l_bit,
eap_ttls=eap_ttls,
name=name,
peap=peap,
preferred_eap_protocol=preferred_eap_protocol,
process_host_lookup=process_host_lookup,
require_message_auth=require_message_auth,
teap=teap,
payload=payload,
active_validation=active_validation,
headers=headers,
**query_parameters
)
[docs] def get_version(self,
headers=None,
**query_parameters):
"""This API helps to retrieve the version information related to
the allowed protocols.
Args:
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'Content-Type' in headers:
check_type(headers.get('Content-Type'),
basestring, may_be_none=False)
if 'Accept' in headers:
check_type(headers.get('Accept'),
basestring, may_be_none=False)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
e_url = ('/ers/config/allowedprotocols/versioninfo')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_c0f61393474f5744ab0a263a232d3b96_v3_1_0', _api_response)