480 lines
17 KiB
Python
480 lines
17 KiB
Python
|
# coding: utf-8
|
||
|
|
|
||
|
|
"""
|
||
|
|
Univention Directory Manager REST interface
|
||
|
|
|
||
|
|
Schema definition for the objects in the Univention Directory Manager REST interface. # noqa: E501
|
||
|
|
|
||
|
|
The version of the OpenAPI document: 1.0.2
|
||
|
|
Generated by: https://openapi-generator.tech
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
from __future__ import absolute_import
|
||
|
|
|
||
|
|
import copy
|
||
|
|
import logging
|
||
|
|
import sys
|
||
|
|
import urllib3
|
||
|
|
|
||
|
|
import six
|
||
|
|
from six.moves import http_client as httplib
|
||
|
|
from openapi_client_udm.exceptions import ApiValueError
|
||
|
|
|
||
|
|
|
||
|
|
JSON_SCHEMA_VALIDATION_KEYWORDS = {
|
||
|
|
'multipleOf', 'maximum', 'exclusiveMaximum',
|
||
|
|
'minimum', 'exclusiveMinimum', 'maxLength',
|
||
|
|
'minLength', 'pattern', 'maxItems', 'minItems'
|
||
|
|
}
|
||
|
|
|
||
|
|
class Configuration(object):
|
||
|
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
||
|
|
|
||
|
|
Ref: https://openapi-generator.tech
|
||
|
|
Do not edit the class manually.
|
||
|
|
|
||
|
|
:param host: Base url
|
||
|
|
:param api_key: Dict to store API key(s).
|
||
|
|
Each entry in the dict specifies an API key.
|
||
|
|
The dict key is the name of the security scheme in the OAS specification.
|
||
|
|
The dict value is the API key secret.
|
||
|
|
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
|
||
|
|
The dict key is the name of the security scheme in the OAS specification.
|
||
|
|
The dict value is an API key prefix when generating the auth data.
|
||
|
|
:param username: Username for HTTP basic authentication
|
||
|
|
:param password: Password for HTTP basic authentication
|
||
|
|
:param discard_unknown_keys: Boolean value indicating whether to discard
|
||
|
|
unknown properties. A server may send a response that includes additional
|
||
|
|
properties that are not known by the client in the following scenarios:
|
||
|
|
1. The OpenAPI document is incomplete, i.e. it does not match the server
|
||
|
|
implementation.
|
||
|
|
2. The client was generated using an older version of the OpenAPI document
|
||
|
|
and the server has been upgraded since then.
|
||
|
|
If a schema in the OpenAPI document defines the additionalProperties attribute,
|
||
|
|
then all undeclared properties received by the server are injected into the
|
||
|
|
additional properties map. In that case, there are undeclared properties, and
|
||
|
|
nothing to discard.
|
||
|
|
:param disabled_client_side_validations (string): Comma-separated list of
|
||
|
|
JSON schema validation keywords to disable JSON schema structural validation
|
||
|
|
rules. The following keywords may be specified: multipleOf, maximum,
|
||
|
|
exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
|
||
|
|
maxItems, minItems.
|
||
|
|
By default, the validation is performed for data generated locally by the client
|
||
|
|
and data received from the server, independent of any validation performed by
|
||
|
|
the server side. If the input data does not satisfy the JSON schema validation
|
||
|
|
rules specified in the OpenAPI document, an exception is raised.
|
||
|
|
If disabled_client_side_validations is set, structural validation is
|
||
|
|
disabled. This can be useful to troubleshoot data validation problem, such as
|
||
|
|
when the OpenAPI document validation rules do not match the actual API data
|
||
|
|
received by the server.
|
||
|
|
:param server_index: Index to servers configuration.
|
||
|
|
:param server_variables: Mapping with string values to replace variables in
|
||
|
|
templated server configuration. The validation of enums is performed for
|
||
|
|
variables with defined enum values before.
|
||
|
|
:param server_operation_index: Mapping from operation ID to an index to server
|
||
|
|
configuration.
|
||
|
|
:param server_operation_variables: Mapping from operation ID to a mapping with
|
||
|
|
string values to replace variables in templated server configuration.
|
||
|
|
The validation of enums is performed for variables with defined enum values before.
|
||
|
|
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
|
||
|
|
in PEM format
|
||
|
|
|
||
|
|
:Example:
|
||
|
|
|
||
|
|
HTTP Basic Authentication Example.
|
||
|
|
Given the following security scheme in the OpenAPI specification:
|
||
|
|
components:
|
||
|
|
securitySchemes:
|
||
|
|
http_basic_auth:
|
||
|
|
type: http
|
||
|
|
scheme: basic
|
||
|
|
|
||
|
|
Configure API client with HTTP basic authentication:
|
||
|
|
|
||
|
|
conf = openapi_client_udm.Configuration(
|
||
|
|
username='the-user',
|
||
|
|
password='the-password',
|
||
|
|
)
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
_default = None
|
||
|
|
|
||
|
|
def __init__(self, host=None,
|
||
|
|
api_key=None, api_key_prefix=None,
|
||
|
|
username=None, password=None,
|
||
|
|
discard_unknown_keys=False,
|
||
|
|
disabled_client_side_validations="",
|
||
|
|
server_index=None, server_variables=None,
|
||
|
|
server_operation_index=None, server_operation_variables=None,
|
||
|
|
ssl_ca_cert=None,
|
||
|
|
):
|
||
|
|
"""Constructor
|
||
|
|
"""
|
||
|
|
self._base_path = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm" if host is None else host
|
||
|
|
"""Default Base url
|
||
|
|
"""
|
||
|
|
self.server_index = 0 if server_index is None and host is None else server_index
|
||
|
|
self.server_operation_index = server_operation_index or {}
|
||
|
|
"""Default server index
|
||
|
|
"""
|
||
|
|
self.server_variables = server_variables or {}
|
||
|
|
self.server_operation_variables = server_operation_variables or {}
|
||
|
|
"""Default server variables
|
||
|
|
"""
|
||
|
|
self.temp_folder_path = None
|
||
|
|
"""Temp file folder for downloading files
|
||
|
|
"""
|
||
|
|
# Authentication Settings
|
||
|
|
self.api_key = {}
|
||
|
|
if api_key:
|
||
|
|
self.api_key = api_key
|
||
|
|
"""dict to store API key(s)
|
||
|
|
"""
|
||
|
|
self.api_key_prefix = {}
|
||
|
|
if api_key_prefix:
|
||
|
|
self.api_key_prefix = api_key_prefix
|
||
|
|
"""dict to store API prefix (e.g. Bearer)
|
||
|
|
"""
|
||
|
|
self.refresh_api_key_hook = None
|
||
|
|
"""function hook to refresh API key if expired
|
||
|
|
"""
|
||
|
|
self.username = username
|
||
|
|
"""Username for HTTP basic authentication
|
||
|
|
"""
|
||
|
|
self.password = password
|
||
|
|
"""Password for HTTP basic authentication
|
||
|
|
"""
|
||
|
|
self.discard_unknown_keys = discard_unknown_keys
|
||
|
|
self.disabled_client_side_validations = disabled_client_side_validations
|
||
|
|
self.logger = {}
|
||
|
|
"""Logging Settings
|
||
|
|
"""
|
||
|
|
self.logger["package_logger"] = logging.getLogger("openapi_client_udm")
|
||
|
|
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
|
||
|
|
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
|
||
|
|
"""Log format
|
||
|
|
"""
|
||
|
|
self.logger_stream_handler = None
|
||
|
|
"""Log stream handler
|
||
|
|
"""
|
||
|
|
self.logger_file_handler = None
|
||
|
|
"""Log file handler
|
||
|
|
"""
|
||
|
|
self.logger_file = None
|
||
|
|
"""Debug file location
|
||
|
|
"""
|
||
|
|
self.debug = False
|
||
|
|
"""Debug switch
|
||
|
|
"""
|
||
|
|
|
||
|
|
self.verify_ssl = True
|
||
|
|
"""SSL/TLS verification
|
||
|
|
Set this to false to skip verifying SSL certificate when calling API
|
||
|
|
from https server.
|
||
|
|
"""
|
||
|
|
self.ssl_ca_cert = ssl_ca_cert
|
||
|
|
"""Set this to customize the certificate file to verify the peer.
|
||
|
|
"""
|
||
|
|
self.cert_file = None
|
||
|
|
"""client certificate file
|
||
|
|
"""
|
||
|
|
self.key_file = None
|
||
|
|
"""client key file
|
||
|
|
"""
|
||
|
|
self.assert_hostname = None
|
||
|
|
"""Set this to True/False to enable/disable SSL hostname verification.
|
||
|
|
"""
|
||
|
|
|
||
|
|
self.connection_pool_maxsize = 100
|
||
|
|
"""This value is passed to the aiohttp to limit simultaneous connections.
|
||
|
|
Default values is 100, None means no-limit.
|
||
|
|
"""
|
||
|
|
|
||
|
|
self.proxy = None
|
||
|
|
"""Proxy URL
|
||
|
|
"""
|
||
|
|
self.proxy_headers = None
|
||
|
|
"""Proxy headers
|
||
|
|
"""
|
||
|
|
self.safe_chars_for_path_param = ''
|
||
|
|
"""Safe chars for path_param
|
||
|
|
"""
|
||
|
|
self.retries = None
|
||
|
|
"""Adding retries to override urllib3 default value 3
|
||
|
|
"""
|
||
|
|
# Enable client side validation
|
||
|
|
self.client_side_validation = True
|
||
|
|
|
||
|
|
self.socket_options = None
|
||
|
|
"""Options to pass down to the underlying urllib3 socket
|
||
|
|
"""
|
||
|
|
|
||
|
|
def __deepcopy__(self, memo):
|
||
|
|
cls = self.__class__
|
||
|
|
result = cls.__new__(cls)
|
||
|
|
memo[id(self)] = result
|
||
|
|
for k, v in self.__dict__.items():
|
||
|
|
if k not in ('logger', 'logger_file_handler'):
|
||
|
|
setattr(result, k, copy.deepcopy(v, memo))
|
||
|
|
# shallow copy of loggers
|
||
|
|
result.logger = copy.copy(self.logger)
|
||
|
|
# use setters to configure loggers
|
||
|
|
result.logger_file = self.logger_file
|
||
|
|
result.debug = self.debug
|
||
|
|
return result
|
||
|
|
|
||
|
|
def __setattr__(self, name, value):
|
||
|
|
object.__setattr__(self, name, value)
|
||
|
|
if name == 'disabled_client_side_validations':
|
||
|
|
s = set(filter(None, value.split(',')))
|
||
|
|
for v in s:
|
||
|
|
if v not in JSON_SCHEMA_VALIDATION_KEYWORDS:
|
||
|
|
raise ApiValueError(
|
||
|
|
"Invalid keyword: '{0}''".format(v))
|
||
|
|
self._disabled_client_side_validations = s
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def set_default(cls, default):
|
||
|
|
"""Set default instance of configuration.
|
||
|
|
|
||
|
|
It stores default configuration, which can be
|
||
|
|
returned by get_default_copy method.
|
||
|
|
|
||
|
|
:param default: object of Configuration
|
||
|
|
"""
|
||
|
|
cls._default = copy.deepcopy(default)
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def get_default_copy(cls):
|
||
|
|
"""Return new instance of configuration.
|
||
|
|
|
||
|
|
This method returns newly created, based on default constructor,
|
||
|
|
object of Configuration class or returns a copy of default
|
||
|
|
configuration passed by the set_default method.
|
||
|
|
|
||
|
|
:return: The configuration object.
|
||
|
|
"""
|
||
|
|
if cls._default is not None:
|
||
|
|
return copy.deepcopy(cls._default)
|
||
|
|
return Configuration()
|
||
|
|
|
||
|
|
@property
|
||
|
|
def logger_file(self):
|
||
|
|
"""The logger file.
|
||
|
|
|
||
|
|
If the logger_file is None, then add stream handler and remove file
|
||
|
|
handler. Otherwise, add file handler and remove stream handler.
|
||
|
|
|
||
|
|
:param value: The logger_file path.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
return self.__logger_file
|
||
|
|
|
||
|
|
@logger_file.setter
|
||
|
|
def logger_file(self, value):
|
||
|
|
"""The logger file.
|
||
|
|
|
||
|
|
If the logger_file is None, then add stream handler and remove file
|
||
|
|
handler. Otherwise, add file handler and remove stream handler.
|
||
|
|
|
||
|
|
:param value: The logger_file path.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
self.__logger_file = value
|
||
|
|
if self.__logger_file:
|
||
|
|
# If set logging file,
|
||
|
|
# then add file handler and remove stream handler.
|
||
|
|
self.logger_file_handler = logging.FileHandler(self.__logger_file)
|
||
|
|
self.logger_file_handler.setFormatter(self.logger_formatter)
|
||
|
|
for _, logger in six.iteritems(self.logger):
|
||
|
|
logger.addHandler(self.logger_file_handler)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def debug(self):
|
||
|
|
"""Debug status
|
||
|
|
|
||
|
|
:param value: The debug status, True or False.
|
||
|
|
:type: bool
|
||
|
|
"""
|
||
|
|
return self.__debug
|
||
|
|
|
||
|
|
@debug.setter
|
||
|
|
def debug(self, value):
|
||
|
|
"""Debug status
|
||
|
|
|
||
|
|
:param value: The debug status, True or False.
|
||
|
|
:type: bool
|
||
|
|
"""
|
||
|
|
self.__debug = value
|
||
|
|
if self.__debug:
|
||
|
|
# if debug status is True, turn on debug logging
|
||
|
|
for _, logger in six.iteritems(self.logger):
|
||
|
|
logger.setLevel(logging.DEBUG)
|
||
|
|
# turn on httplib debug
|
||
|
|
httplib.HTTPConnection.debuglevel = 1
|
||
|
|
else:
|
||
|
|
# if debug status is False, turn off debug logging,
|
||
|
|
# setting log level to default `logging.WARNING`
|
||
|
|
for _, logger in six.iteritems(self.logger):
|
||
|
|
logger.setLevel(logging.WARNING)
|
||
|
|
# turn off httplib debug
|
||
|
|
httplib.HTTPConnection.debuglevel = 0
|
||
|
|
|
||
|
|
@property
|
||
|
|
def logger_format(self):
|
||
|
|
"""The logger format.
|
||
|
|
|
||
|
|
The logger_formatter will be updated when sets logger_format.
|
||
|
|
|
||
|
|
:param value: The format string.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
return self.__logger_format
|
||
|
|
|
||
|
|
@logger_format.setter
|
||
|
|
def logger_format(self, value):
|
||
|
|
"""The logger format.
|
||
|
|
|
||
|
|
The logger_formatter will be updated when sets logger_format.
|
||
|
|
|
||
|
|
:param value: The format string.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
self.__logger_format = value
|
||
|
|
self.logger_formatter = logging.Formatter(self.__logger_format)
|
||
|
|
|
||
|
|
def get_api_key_with_prefix(self, identifier, alias=None):
|
||
|
|
"""Gets API key (with prefix if set).
|
||
|
|
|
||
|
|
:param identifier: The identifier of apiKey.
|
||
|
|
:param alias: The alternative identifier of apiKey.
|
||
|
|
:return: The token for api key authentication.
|
||
|
|
"""
|
||
|
|
if self.refresh_api_key_hook is not None:
|
||
|
|
self.refresh_api_key_hook(self)
|
||
|
|
key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
|
||
|
|
if key:
|
||
|
|
prefix = self.api_key_prefix.get(identifier)
|
||
|
|
if prefix:
|
||
|
|
return "%s %s" % (prefix, key)
|
||
|
|
else:
|
||
|
|
return key
|
||
|
|
|
||
|
|
def get_basic_auth_token(self):
|
||
|
|
"""Gets HTTP basic authentication header (string).
|
||
|
|
|
||
|
|
:return: The token for basic HTTP authentication.
|
||
|
|
"""
|
||
|
|
username = ""
|
||
|
|
if self.username is not None:
|
||
|
|
username = self.username
|
||
|
|
password = ""
|
||
|
|
if self.password is not None:
|
||
|
|
password = self.password
|
||
|
|
return urllib3.util.make_headers(
|
||
|
|
basic_auth=username + ':' + password
|
||
|
|
).get('authorization')
|
||
|
|
|
||
|
|
def auth_settings(self):
|
||
|
|
"""Gets Auth Settings dict for api client.
|
||
|
|
|
||
|
|
:return: The Auth Settings information dict.
|
||
|
|
"""
|
||
|
|
auth = {}
|
||
|
|
if self.username is not None and self.password is not None:
|
||
|
|
auth['basic'] = {
|
||
|
|
'type': 'basic',
|
||
|
|
'in': 'header',
|
||
|
|
'key': 'Authorization',
|
||
|
|
'value': self.get_basic_auth_token()
|
||
|
|
}
|
||
|
|
return auth
|
||
|
|
|
||
|
|
def to_debug_report(self):
|
||
|
|
"""Gets the essential information for debugging.
|
||
|
|
|
||
|
|
:return: The report for debugging.
|
||
|
|
"""
|
||
|
|
return "Python SDK Debug Report:\n"\
|
||
|
|
"OS: {env}\n"\
|
||
|
|
"Python Version: {pyversion}\n"\
|
||
|
|
"Version of the API: 1.0.2\n"\
|
||
|
|
"SDK Package Version: 1.0.2".\
|
||
|
|
format(env=sys.platform, pyversion=sys.version)
|
||
|
|
|
||
|
|
def get_host_settings(self):
|
||
|
|
"""Gets an array of host settings
|
||
|
|
|
||
|
|
:return: An array of host settings
|
||
|
|
"""
|
||
|
|
return [
|
||
|
|
{
|
||
|
|
'url': "https://ucs.sawtooth.claremontmakerspace.org/univention/udm",
|
||
|
|
'description': "No description provided",
|
||
|
|
},
|
||
|
|
{
|
||
|
|
'url': "http://ucs.sawtooth.claremontmakerspace.org/univention/udm",
|
||
|
|
'description': "No description provided",
|
||
|
|
},
|
||
|
|
{
|
||
|
|
'url': "https://172.18.142.8/univention/udm",
|
||
|
|
'description': "No description provided",
|
||
|
|
},
|
||
|
|
{
|
||
|
|
'url': "http://172.18.142.8/univention/udm",
|
||
|
|
'description': "No description provided",
|
||
|
|
}
|
||
|
|
]
|
||
|
|
|
||
|
|
def get_host_from_settings(self, index, variables=None, servers=None):
|
||
|
|
"""Gets host URL based on the index and variables
|
||
|
|
:param index: array index of the host settings
|
||
|
|
:param variables: hash of variable and the corresponding value
|
||
|
|
:param servers: an array of host settings or None
|
||
|
|
:return: URL based on host settings
|
||
|
|
"""
|
||
|
|
if index is None:
|
||
|
|
return self._base_path
|
||
|
|
|
||
|
|
variables = {} if variables is None else variables
|
||
|
|
servers = self.get_host_settings() if servers is None else servers
|
||
|
|
|
||
|
|
try:
|
||
|
|
server = servers[index]
|
||
|
|
except IndexError:
|
||
|
|
raise ValueError(
|
||
|
|
"Invalid index {0} when selecting the host settings. "
|
||
|
|
"Must be less than {1}".format(index, len(servers)))
|
||
|
|
|
||
|
|
url = server['url']
|
||
|
|
|
||
|
|
# go through variables and replace placeholders
|
||
|
|
for variable_name, variable in server.get('variables', {}).items():
|
||
|
|
used_value = variables.get(
|
||
|
|
variable_name, variable['default_value'])
|
||
|
|
|
||
|
|
if 'enum_values' in variable \
|
||
|
|
and used_value not in variable['enum_values']:
|
||
|
|
raise ValueError(
|
||
|
|
"The variable `{0}` in the host URL has invalid value "
|
||
|
|
"{1}. Must be {2}.".format(
|
||
|
|
variable_name, variables[variable_name],
|
||
|
|
variable['enum_values']))
|
||
|
|
|
||
|
|
url = url.replace("{" + variable_name + "}", used_value)
|
||
|
|
|
||
|
|
return url
|
||
|
|
|
||
|
|
@property
|
||
|
|
def host(self):
|
||
|
|
"""Return generated host."""
|
||
|
|
return self.get_host_from_settings(self.server_index, variables=self.server_variables)
|
||
|
|
|
||
|
|
@host.setter
|
||
|
|
def host(self, value):
|
||
|
|
"""Fix base path."""
|
||
|
|
self._base_path = value
|
||
|
|
self.server_index = None
|