# -*- coding: utf-8 -*-
"""Cisco Identity Services Engine Network Access - Time/Date Conditions 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 NetworkAccessTimeDateConditions(object):
"""Identity Services Engine Network Access - Time/Date Conditions API (version: 3.2_beta).
Wraps the Identity Services Engine Network Access - Time/Date Conditions
API and exposes the API as native Python
methods that return native Python objects.
Policy APIs for manage Policy Sets, authorization policies, authentication policies, and policy elements.
"""
def __init__(self, session, object_factory, request_validator):
"""Initialize a new NetworkAccessTimeDateConditions
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(NetworkAccessTimeDateConditions, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def get_network_access_time_conditions(self,
headers=None,
**query_parameters):
"""Network Access Returns a list of time and date conditions.
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 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
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 = ('/api/v1/policy/network-access/time-condition')
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_ab916b19789c59b79dddbc2d0a3c57fc_v3_2_beta', _api_response)
[docs] def get_all(self,
headers=None,
**query_parameters):
"""Alias for `get_network_access_time_conditions <#ciscoisesdk.
api.v3_2_beta.network_access_time_date_conditions.
NetworkAccessTimeDateConditions.get_network_access_time_conditions>`_
"""
return self.get_network_access_time_conditions(
headers=headers,
**query_parameters
)
[docs] def create_network_access_time_condition(self,
attribute_id=None,
attribute_name=None,
attribute_value=None,
children=None,
condition_type=None,
dates_range=None,
dates_range_exception=None,
description=None,
dictionary_name=None,
dictionary_value=None,
hours_range=None,
hours_range_exception=None,
id=None,
is_negate=None,
link=None,
name=None,
operator=None,
week_days=None,
week_days_exception=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Network Access Creates time/date condition.
Args:
attribute_id(string): Dictionary attribute id
(Optional), used for additional
verification, property of the request
body.
attribute_name(string): Dictionary attribute name,
property of the request body.
attribute_value(string): Attribute value for condition
Value type is specified in dictionary
object if multiple values allowed is
specified in dictionary object, property
of the request body.
children(list): In case type is andBlock or orBlock
addtional conditions will be aggregated
under this logical (OR/AND) condition,
property of the request body (list of
objects).
condition_type(string): Inidicates whether the record is
the condition itself(data) or a
logical(or,and) aggregation Data type
enum(reference,single) indicates than
"conditonId" OR "ConditionAttrs" fields
should contain condition data but not
both Logical aggreation(and,or) enum
indicates that additional conditions are
present under the children field,
property of the request body. Available
values are 'ConditionReference',
'ConditionAttributes',
'LibraryConditionAttributes',
'ConditionAndBlock',
'LibraryConditionAndBlock',
'ConditionOrBlock',
'LibraryConditionOrBlock' and
'TimeAndDateCondition'.
dates_range(object): Defines for which date/s
TimeAndDate condition will be matched or
NOT matched if used in exceptionDates
prooperty Options are Date range, for
specific date, the same date should be
used for start/end date Default no
specific dates In order to reset the
dates to have no specific dates Date
format yyyy-mm-dd (MM = month, dd = day,
yyyy = year), property of the request
body.
dates_range_exception(object): Defines for which date/s
TimeAndDate condition will be matched or
NOT matched if used in exceptionDates
prooperty Options are Date range, for
specific date, the same date should be
used for start/end date Default no
specific dates In order to reset the
dates to have no specific dates Date
format yyyy-mm-dd (MM = month, dd = day,
yyyy = year), property of the request
body.
description(string): Condition description, property of
the request body.
dictionary_name(string): Dictionary name, property of
the request body.
dictionary_value(string): Dictionary value, property of
the request body.
hours_range(object): Defines for which hours a
TimeAndDate condition will be matched or
not matched if used in exceptionHours
property Time foramt hh:mm ( h = hour
, mm = minutes ) Default All Day ,
property of the request body.
hours_range_exception(object): Defines for which hours a
TimeAndDate condition will be matched or
not matched if used in exceptionHours
property Time foramt hh:mm ( h = hour
, mm = minutes ) Default All Day ,
property of the request body.
id(string): id, property of the request body.
is_negate(boolean): Indicates whereas this condition is
in negate mode, property of the request
body.
link(object): link, property of the request body.
name(string): Condition name, property of the request
body.
operator(string): Equality operator, property of the
request body. Available values are
'equals', 'notEquals', 'contains',
'notContains', 'matches', 'in', 'notIn',
'startsWith', 'notStartsWith',
'endsWith', 'notEndsWith',
'greaterThan', 'lessThan',
'greaterOrEquals', 'lessOrEquals',
'ipGreaterThan', 'ipLessThan',
'ipEquals' and 'ipNotEquals'.
week_days(list): Defines for which days this condition
will be matched Days format Arrays of
WeekDay enums Default List of All week
days, property of the request body (list
of strings. Available values are
'Sunday', 'Monday', 'Tuesday',
'Wednesday', 'Thursday', 'Friday' and
'Saturday').
week_days_exception(list): Defines for which days this
condition will NOT be matched Days
format Arrays of WeekDay enums Default
Not enabled, property of the request
body (list of strings. Available values
are 'Sunday', 'Monday', 'Tuesday',
'Wednesday', 'Thursday', 'Friday' and
'Saturday').
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 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
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:
_payload = {
'conditionType':
condition_type,
'isNegate':
is_negate,
'link':
link,
'description':
description,
'id':
id,
'name':
name,
'attributeName':
attribute_name,
'attributeId':
attribute_id,
'attributeValue':
attribute_value,
'dictionaryName':
dictionary_name,
'dictionaryValue':
dictionary_value,
'operator':
operator,
'children':
children,
'datesRange':
dates_range,
'datesRangeException':
dates_range_exception,
'hoursRange':
hours_range,
'hoursRangeException':
hours_range_exception,
'weekDays':
week_days,
'weekDaysException':
week_days_exception,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_b314d32b258a1b53c5c84cf84d396_v3_2_beta')\
.validate(_payload)
e_url = ('/api/v1/policy/network-access/time-condition')
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_b314d32b258a1b53c5c84cf84d396_v3_2_beta', _api_response)
[docs] def create(self,
attribute_id=None,
attribute_name=None,
attribute_value=None,
children=None,
condition_type=None,
dates_range=None,
dates_range_exception=None,
description=None,
dictionary_name=None,
dictionary_value=None,
hours_range=None,
hours_range_exception=None,
id=None,
is_negate=None,
link=None,
name=None,
operator=None,
week_days=None,
week_days_exception=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Alias for `create_network_access_time_condition <#ciscoisesdk.
api.v3_2_beta.network_access_time_date_conditions.
NetworkAccessTimeDateConditions.create_network_access_time_condition>`_
"""
return self.create_network_access_time_condition(
attribute_id=attribute_id,
attribute_name=attribute_name,
attribute_value=attribute_value,
children=children,
condition_type=condition_type,
dates_range=dates_range,
dates_range_exception=dates_range_exception,
description=description,
dictionary_name=dictionary_name,
dictionary_value=dictionary_value,
hours_range=hours_range,
hours_range_exception=hours_range_exception,
id=id,
is_negate=is_negate,
link=link,
name=name,
operator=operator,
week_days=week_days,
week_days_exception=week_days_exception,
payload=payload,
active_validation=active_validation,
headers=headers,
**query_parameters
)
[docs] def get_network_access_time_condition_by_id(self,
id,
headers=None,
**query_parameters):
"""Network Access returns a network condition.
Args:
id(basestring): id path parameter. Condition id.
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 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
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 = ('/api/v1/policy/network-access/time-condition/{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_c941303330bc5615b3eb8d4d2702b874_v3_2_beta', _api_response)
[docs] def get_by_id(self,
id,
headers=None,
**query_parameters):
"""Alias for `get_network_access_time_condition_by_id <#ciscoisesdk.
api.v3_2_beta.network_access_time_date_conditions.
NetworkAccessTimeDateConditions.get_network_access_time_condition_by_id>`_
"""
return self.get_network_access_time_condition_by_id(
id=id,
headers=headers,
**query_parameters
)
[docs] def update_network_access_time_condition_by_id(self,
id,
attribute_id=None,
attribute_name=None,
attribute_value=None,
children=None,
condition_type=None,
dates_range=None,
dates_range_exception=None,
description=None,
dictionary_name=None,
dictionary_value=None,
hours_range=None,
hours_range_exception=None,
is_negate=None,
link=None,
name=None,
operator=None,
week_days=None,
week_days_exception=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Network Access Update network condition.
Args:
attribute_id(string): Dictionary attribute id
(Optional), used for additional
verification, property of the request
body.
attribute_name(string): Dictionary attribute name,
property of the request body.
attribute_value(string): Attribute value for condition
Value type is specified in dictionary
object if multiple values allowed is
specified in dictionary object, property
of the request body.
children(list): In case type is andBlock or orBlock
addtional conditions will be aggregated
under this logical (OR/AND) condition,
property of the request body (list of
objects).
condition_type(string): Inidicates whether the record is
the condition itself(data) or a
logical(or,and) aggregation Data type
enum(reference,single) indicates than
"conditonId" OR "ConditionAttrs" fields
should contain condition data but not
both Logical aggreation(and,or) enum
indicates that additional conditions are
present under the children field,
property of the request body. Available
values are 'ConditionReference',
'ConditionAttributes',
'LibraryConditionAttributes',
'ConditionAndBlock',
'LibraryConditionAndBlock',
'ConditionOrBlock',
'LibraryConditionOrBlock' and
'TimeAndDateCondition'.
dates_range(object): Defines for which date/s
TimeAndDate condition will be matched or
NOT matched if used in exceptionDates
prooperty Options are Date range, for
specific date, the same date should be
used for start/end date Default no
specific dates In order to reset the
dates to have no specific dates Date
format yyyy-mm-dd (MM = month, dd = day,
yyyy = year), property of the request
body.
dates_range_exception(object): Defines for which date/s
TimeAndDate condition will be matched or
NOT matched if used in exceptionDates
prooperty Options are Date range, for
specific date, the same date should be
used for start/end date Default no
specific dates In order to reset the
dates to have no specific dates Date
format yyyy-mm-dd (MM = month, dd = day,
yyyy = year), property of the request
body.
description(string): Condition description, property of
the request body.
dictionary_name(string): Dictionary name, property of
the request body.
dictionary_value(string): Dictionary value, property of
the request body.
hours_range(object): Defines for which hours a
TimeAndDate condition will be matched or
not matched if used in exceptionHours
property Time foramt hh:mm ( h = hour
, mm = minutes ) Default All Day ,
property of the request body.
hours_range_exception(object): Defines for which hours a
TimeAndDate condition will be matched or
not matched if used in exceptionHours
property Time foramt hh:mm ( h = hour
, mm = minutes ) Default All Day ,
property of the request body.
id(string): id, property of the request body.
is_negate(boolean): Indicates whereas this condition is
in negate mode, property of the request
body.
link(object): link, property of the request body.
name(string): Condition name, property of the request
body.
operator(string): Equality operator, property of the
request body. Available values are
'equals', 'notEquals', 'contains',
'notContains', 'matches', 'in', 'notIn',
'startsWith', 'notStartsWith',
'endsWith', 'notEndsWith',
'greaterThan', 'lessThan',
'greaterOrEquals', 'lessOrEquals',
'ipGreaterThan', 'ipLessThan',
'ipEquals' and 'ipNotEquals'.
week_days(list): Defines for which days this condition
will be matched Days format Arrays of
WeekDay enums Default List of All week
days, property of the request body (list
of strings. Available values are
'Sunday', 'Monday', 'Tuesday',
'Wednesday', 'Thursday', 'Friday' and
'Saturday').
week_days_exception(list): Defines for which days this
condition will NOT be matched Days
format Arrays of WeekDay enums Default
Not enabled, property of the request
body (list of strings. Available values
are 'Sunday', 'Monday', 'Tuesday',
'Wednesday', 'Thursday', 'Friday' and
'Saturday').
id(basestring): id path parameter. Condition id.
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 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
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:
_payload = {
'conditionType':
condition_type,
'isNegate':
is_negate,
'link':
link,
'description':
description,
'id':
id,
'name':
name,
'attributeName':
attribute_name,
'attributeId':
attribute_id,
'attributeValue':
attribute_value,
'dictionaryName':
dictionary_name,
'dictionaryValue':
dictionary_value,
'operator':
operator,
'children':
children,
'datesRange':
dates_range,
'datesRangeException':
dates_range_exception,
'hoursRange':
hours_range,
'hoursRangeException':
hours_range_exception,
'weekDays':
week_days,
'weekDaysException':
week_days_exception,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_a518d5655f69e8687c9c98740c6_v3_2_beta')\
.validate(_payload)
e_url = ('/api/v1/policy/network-access/time-condition/{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_a518d5655f69e8687c9c98740c6_v3_2_beta', _api_response)
[docs] def update_by_id(self,
id,
attribute_id=None,
attribute_name=None,
attribute_value=None,
children=None,
condition_type=None,
dates_range=None,
dates_range_exception=None,
description=None,
dictionary_name=None,
dictionary_value=None,
hours_range=None,
hours_range_exception=None,
is_negate=None,
link=None,
name=None,
operator=None,
week_days=None,
week_days_exception=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Alias for `update_network_access_time_condition_by_id <#ciscoisesdk.
api.v3_2_beta.network_access_time_date_conditions.
NetworkAccessTimeDateConditions.update_network_access_time_condition_by_id>`_
"""
return self.update_network_access_time_condition_by_id(
id=id,
attribute_id=attribute_id,
attribute_name=attribute_name,
attribute_value=attribute_value,
children=children,
condition_type=condition_type,
dates_range=dates_range,
dates_range_exception=dates_range_exception,
description=description,
dictionary_name=dictionary_name,
dictionary_value=dictionary_value,
hours_range=hours_range,
hours_range_exception=hours_range_exception,
is_negate=is_negate,
link=link,
name=name,
operator=operator,
week_days=week_days,
week_days_exception=week_days_exception,
payload=payload,
active_validation=active_validation,
headers=headers,
**query_parameters
)
[docs] def delete_network_access_time_condition_by_id(self,
id,
headers=None,
**query_parameters):
"""Network Access Delete Time/Date condition.
Args:
id(basestring): id path parameter. Condition id.
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 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
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 = ('/api/v1/policy/network-access/time-condition/{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_e2a697abfe2058d3adc7ad9922f5a5d6_v3_2_beta', _api_response)
[docs] def delete_by_id(self,
id,
headers=None,
**query_parameters):
"""Alias for `delete_network_access_time_condition_by_id <#ciscoisesdk.
api.v3_2_beta.network_access_time_date_conditions.
NetworkAccessTimeDateConditions.delete_network_access_time_condition_by_id>`_
"""
return self.delete_network_access_time_condition_by_id(
id=id,
headers=headers,
**query_parameters
)