keycloak.connection

Module Contents

Classes

ConnectionManager

Represents a simple server connection.

class keycloak.connection.ConnectionManager(base_url, headers={}, timeout=60, verify=True, proxies=None)[source]

Bases: object

Represents a simple server connection.

Parameters
  • base_url – (str) The server URL.

  • headers – (dict) The header parameters of the requests to the server.

  • timeout – (int) Timeout to use for requests to the server.

  • verify – (bool) Verify server SSL.

  • proxies – (dict) The proxies servers requests is sent by.

__del__(self)[source]
property base_url(self)[source]

Return base url in use for requests to the server.

property timeout(self)[source]

Return timeout in use for request to the server.

property verify(self)[source]

Return verify in use for request to the server.

property headers(self)[source]

Return header request to the server.

param_headers(self, key)[source]

Return a specific header parameter.

Parameters

key – (str) Header parameters key.

Returns

If the header parameters exist, return its value.

clean_headers(self)[source]

Clear header parameters.

exist_param_headers(self, key)[source]

Check if the parameter exists in the header.

Parameters

key – (str) Header parameters key.

Returns

If the header parameters exist, return True.

add_param_headers(self, key, value)[source]

Add a single parameter inside the header.

Parameters
  • key – (str) Header parameters key.

  • value – (str) Value to be added.

del_param_headers(self, key)[source]

Remove a specific parameter.

:arg

key (str): Key of the header parameters.

raw_get(self, path, **kwargs)[source]

Submit get request to the path.

Parameters

path – (str) Path for request.

Returns

Response the request.

Raises

HttpError Can’t connect to server.

raw_post(self, path, data, **kwargs)[source]

Submit post request to the path.

Parameters
  • path – (str) Path for request.

  • data – (dict) Payload for request.

Returns

Response the request.

Raises

HttpError Can’t connect to server.

raw_put(self, path, data, **kwargs)[source]

Submit put request to the path.

Parameters
  • path – (str) Path for request.

  • data – (dict) Payload for request.

Returns

Response the request.

Raises

HttpError Can’t connect to server.

raw_delete(self, path, data={}, **kwargs)[source]

Submit delete request to the path.

Parameters
  • path – (str) Path for request.

  • data – (dict) Payload for request.

Returns

Response the request.

Raises

HttpError Can’t connect to server.