univention.admin.rest.client package

Sample Client for the UDM REST API.

>>> from univention.admin.rest.client import UDM
>>> uri = 'http://localhost/univention/udm/'
>>> udm = UDM.http(uri, 'Administrator', 'univention')
>>> module = udm.get('users/user')
>>> print('Found {}'.format(module))
>>> obj = next(module.search())
>>> if obj:
>>>     obj = obj.open()
>>> print('Object {}'.format(obj))

exception univention.admin.rest.client.HTTPError(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: Exception

Generic HTTP Error.

errors = {400: <class 'univention.admin.rest.client.BadRequest'>, 401: <class 'univention.admin.rest.client.Unauthorized'>, 403: <class 'univention.admin.rest.client.Forbidden'>, 404: <class 'univention.admin.rest.client.NotFound'>, 412: <class 'univention.admin.rest.client.PreconditionFailed'>, 422: <class 'univention.admin.rest.client.UnprocessableEntity'>, 429: <class 'univention.admin.rest.client.TooManyRequests'>, 500: <class 'univention.admin.rest.client.ServerError'>, 503: <class 'univention.admin.rest.client.ServiceUnavailable'>}

code

response

error_details

exception univention.admin.rest.client.BadRequest(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 400 Bad Request error.

code

error_details

response

exception univention.admin.rest.client.Unauthorized(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 401 Unauthorized error.

code

error_details

response

exception univention.admin.rest.client.Forbidden(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 403 Forbidden error.

code

error_details

response

exception univention.admin.rest.client.NotFound(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 404 Not Found error.

code

error_details

response

exception univention.admin.rest.client.PreconditionFailed(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 412 Precondition Failed error.

code

error_details

response

exception univention.admin.rest.client.UnprocessableEntity(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 422 Unprocessable Entity error.

code

error_details

response

exception univention.admin.rest.client.TooManyRequests(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 429 Too Many Requests error.

code

error_details

response

exception univention.admin.rest.client.ServerError(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 500 Internal Server error.

code

error_details

response

exception univention.admin.rest.client.ServiceUnavailable(code: int, message: str, response: Response | None, error_details: dict | None = None)

Bases: HTTPError

A 503 Service Unavailable error.

code

error_details

response

exception univention.admin.rest.client.ConnectionError

Bases: Exception

A HTTP Connection error.

exception univention.admin.rest.client.UnexpectedResponse

Bases: ConnectionError

A unexpected response payload error (e.g. not JSON).

class univention.admin.rest.client.Response(response: Response, data: Any, uri: str)

Bases: object

Response wrapper.

response

data

uri

class univention.admin.rest.client.Session(credentials: UDM, language: str = 'en-US', reconnect: bool = True, user_agent: str = 'univention.lib/1.0', enable_caching: bool = False)

Bases: object

A session holding credentials and language settings for a client.

language

credentials

reconnect

user_agent

enable_caching

default_headers

session

create_session() → Session

get_method(method: str) → Callable[..., _ResponseType]

request(method: str, uri: str, data: dict | None = None, expect_json: bool = False, **headers: str) → Any

make_request(method: str, uri: str, data: dict | None = None, expect_json: bool = False, allow_redirects: bool = True, custom_redirect_handling: bool = False, **headers: str) → Response

eval_response(response: Response, expect_json: bool = False) → Any

get_relations(entry: dict, relation: str, name: str | None = None, template: dict[str, Any] | None = None) → Iterator[dict[str, str]]

has_relation(entry: dict, relation: str, name: str | None = None, template: dict[str, Any] | None = None) → bool

get_relation(entry: dict, relation: str, name: str | None = None, template: dict[str, Any] | None = None) → dict[str, str]

resolve_relations(entry: dict, relation: str, name: str | None = None, template: dict[str, Any] | None = None) → Iterator[Any]

resolve_relation(entry: dict, relation: str, name: str | None = None, template: dict[str, Any] | None = None) → Any

class univention.admin.rest.client.Client(client: Session)

Bases: object

Abstract client base class.

client

class univention.admin.rest.client.UDM(uri: str, username: str, password: str, *args: Any, **kwargs: Any)

Bases: Client

Univention Directory Manager client.

classmethod http(uri: str, username: str, password: str) → Self

classmethod bearer(uri: str, bearer_token: str) → Self

uri

username

password

bearer_token

entry: Any

load() → None

reload() → None

get_ldap_base() → str | None

modules(name: str | None = None) → Iterator[Module]

obj_by_dn(dn: str) → Object

obj_by_uuid(uuid: str) → Object

get(name: str) → Module | None

get_object(object_type: str, dn: str) → Object | None

version(api_version: str) → Self

class univention.admin.rest.client.Module(udm: UDM, uri: str, name: str, title: str, *args: Any, **kwargs: Any)

Bases: Client

A UDM module representation.

udm

uri

username

password

name

title

relations: dict

load_relations() → None

new(position: str | None = None, superordinate: str | None = None, template: dict[str, Any] | None = None) → Object

get(dn: str, properties: list[str] | None = None) → Object | None

get_by_entry_uuid(uuid: str, properties: list[str] | None = None) → Object | None

get_by_id(dn: str, properties: list[str] | None = None) → Object | None

search(filter: dict[str, str] | str | None = None, position: str | None = None, scope: str | None = 'sub', hidden: bool = False, superordinate: str | None = None, opened: bool = False, properties: list[str] | None = None) → Iterator[Any]

Search objects.

search_paginated(filter: dict[str, str] | str | None = None, position: str | None = None, scope: str | None = 'sub', hidden: bool = False, superordinate: str | None = None, opened: bool = False, properties: list[str] | None = None, page_size: int = 50, sort_by: str | list[str] | None = None, reverse: bool = False, pagination: bool = False) → Iterator[Any]

Yield all search results by following server-provided page links.

search_page(filter: dict[str, str] | str | None = None, position: str | None = None, scope: str | None = 'sub', hidden: bool = False, superordinate: str | None = None, opened: bool = False, properties: list[str] | None = None, page_size: int | None = 50, page: int = 1, sort_by: str | list[str] | None = None, reverse: bool = False, pagination: bool = False) → _SearchPage

Return one paginated search result page including navigation metadata.

get_layout() → Any | None

get_properties() → Any | None

get_property_choices(property: str) → Any | None

policy_result(policy_module: str, position: str, policy: str | None = None) → dict

get_report_types() → list[str]

create_report(report_type: str, object_dns: list[str]) → Any

class univention.admin.rest.client.ShallowObject(udm: UDM, dn: str | None, uri: str, *args: Any, **kwargs: Any)

Bases: Client

A reference to an UDM object, which is not recevied from server yet.

dn

udm

uri

open() → Object

class univention.admin.rest.client.References(obj: Object | None = None)

Bases: object

obj

udm

class univention.admin.rest.client.Object(udm: UDM, representation: dict, etag: str | None = None, last_modified: str | None = None, *args: Any, **kwargs: Any)

Bases: Client

A UDM object with related references.

property module

property object_type: str

property dn: str | None

property properties

property options: dict

property policies: dict

property superordinate: str | None

property position: str | None

property uri: str | None

classmethod from_response(udm: UDM, response: Response) → Object

classmethod from_data(udm: UDM, entry: dict, headers: Mapping[str, str] | None = None) → Object

udm

representation

hal

etag

last_modified

reload() → None

save(reload: bool = True) → Response

json_patch(patch: dict, reload: bool = True) → Response

delete(remove_referring: bool = False) → bytes

restore(reload: bool = True) → Response

Restore an object from the Recycle Bin.

move(position: str, reload: bool = True) → None

generate_service_specific_password(service: str) → Any | None

get_layout() → Any | None

get_properties() → Any | None

get_property_choices(property: str) → Any | None

policy_result(policy_module: str, policy: str | None = None) → dict

class univention.admin.rest.client.PatchDocument

Bases: object

application/json-patch+json representation

patch

add(path_segments, value)

replace(path_segments, value)

remove(path_segments, value)

move(path_segments, from_segments)

copy(path_segments, from_segments)

test(path_segments, value)

expand_path(path_segments)