geonode.geoserver.acl.gsauth_client.configuration

GeoServer ACL

GeoServer Access Control List API # noqa: E501

The version of the OpenAPI document: 1.0.0 Generated by: https://openapi-generator.tech

Attributes

JSON_SCHEMA_VALIDATION_KEYWORDS

Classes

Configuration

NOTE: This class is auto generated by OpenAPI Generator

Module Contents

geonode.geoserver.acl.gsauth_client.configuration.JSON_SCHEMA_VALIDATION_KEYWORDS

class geonode.geoserver.acl.gsauth_client.configuration.Configuration(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)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters:

• host – Base url

• 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.

• 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.

• username – Username for HTTP basic authentication

• password – Password for HTTP basic authentication

• 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.

Parameters:

• (string) (disabled_client_side_validations) – 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.

• server_index – Index to servers configuration.

• 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.

• server_operation_index – Mapping from operation ID to an index to server configuration.

• 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.

• 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 = gsauth_client.Configuration(

username=’the-user’, password=’the-password’, )

_default = None

_base_path

Default Base url

server_index

server_operation_index

Default server index

server_variables

server_operation_variables

Default server variables

temp_folder_path = None

Temp file folder for downloading files

api_key

api_key_prefix

refresh_api_key_hook = None

function hook to refresh API key if expired

username

Username for HTTP basic authentication

password

Password for HTTP basic authentication

discard_unknown_keys

disabled_client_side_validations

logger

Logging Settings

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters:

value – The format string.

Type:

str

logger_stream_handler = None

Log stream handler

logger_file_handler = None

Log file handler

property logger_file

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.

Parameters:

value – The logger_file path.

Type:

str

property debug

Debug status

Parameters:

value – The debug status, True or False.

Type:

bool

verify_ssl = True

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

ssl_ca_cert

Set this to customize the certificate file to verify the peer.

cert_file = None

client certificate file

key_file = None

client key file

assert_hostname = None

Set this to True/False to enable/disable SSL hostname verification.

connection_pool_maxsize

urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

proxy = None

Proxy URL

proxy_headers = None

Proxy headers

safe_chars_for_path_param = ''

Safe chars for path_param

retries = None

Adding retries to override urllib3 default value 3

client_side_validation = True

socket_options = None

Options to pass down to the underlying urllib3 socket

__deepcopy__(memo)

__setattr__(name, value)

classmethod set_default(default)

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters:

default – object of Configuration

classmethod get_default_copy()

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.

Returns:

The configuration object.

get_api_key_with_prefix(identifier, alias=None)

Gets API key (with prefix if set).

Parameters:

• identifier – The identifier of apiKey.

• alias – The alternative identifier of apiKey.

Returns:

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns:

The token for basic HTTP authentication.

auth_settings()

Gets Auth Settings dict for api client.

Returns:

The Auth Settings information dict.

to_debug_report()

Gets the essential information for debugging.

Returns:

The report for debugging.

get_host_settings()

Gets an array of host settings

Returns:

An array of host settings

get_host_from_settings(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

property host

Return generated host.