Skip to content

Users

pynteracta.api.users

Users resource client (endpoints 3-5).

UsersAPI

Bases: ResourceClient

Client for user listing, profile, and admin lookup endpoints.

Source code in src/pynteracta/api/users.py 
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class UsersAPI(ResourceClient):
    """Client for user listing, profile, and admin lookup endpoints."""

    def __init__(self, transport: HttpTransport) -> None:
        super().__init__(transport)

    def list(  # noqa: PLR0913
        self,
        *,
        page_token: str | None = None,
        page_size: int | None = None,
        calculate_total_items_count: bool | None = None,
        # --- curated filters ---
        full_text_filter: str | None = None,
        status_filter: list[int] | None = None,
        workspace_ids: list[int] | None = None,
        community_ids: list[int] | None = None,
        creation_timestamp_from: int | float | str | datetime | None = None,
        creation_timestamp_to: int | float | str | datetime | None = None,
        last_access_timestamp_from: int | float | str | datetime | None = None,
        last_access_timestamp_to: int | float | str | datetime | None = None,
        role: str | None = None,
        # --- ordering ---
        order_by: str | None = None,
        order_desc: bool | None = None,
        # --- escape hatch ---
        **filters: Any,
    ) -> SystemUserList:
        """POST ``/admin/data/users`` with curated filter and ordering kwargs.

        Args:
            page_token: Opaque token for the page to fetch.
            page_size: Items per page.
            calculate_total_items_count: Ask the API to populate ``totalItemsCount``.
            full_text_filter: Full-text filter on name, surname, and email
                (``fullTextFilter``).
            status_filter: Filter by user status ids (``statusFilter``).
            workspace_ids: Filter by workspace ids (``workspaceIds``).
            community_ids: Filter by community ids (``communityIds``).
            creation_timestamp_from: Lower bound on creation date — epoch-ms ``int``,
                :class:`~datetime.datetime`, or ISO-8601 ``str`` (``creationTimestampFrom``).
            creation_timestamp_to: Upper bound on creation date (``creationTimestampTo``).
            last_access_timestamp_from: Lower bound on last-access date
                (``lastAccessTimestampFrom``).
            last_access_timestamp_to: Upper bound on last-access date
                (``lastAccessTimestampTo``).
            role: Filter by role (``role``).
            order_by: Sort field id — mapped to ``orderTypeId`` (passthrough, no client-side
                validation).
            order_desc: Descending sort (``True``) or ascending (``False``) — ``orderDesc``.
            **filters: Additional snake_case fields forwarded to the request body (converted to
                camelCase). Escape hatch for the long-tail ``ListSystemUsersRequestDTO`` fields
                not promoted to explicit kwargs (e.g. ``business_unit_ids``, ``area_ids``,
                ``manager_ids``, ``lang``, ``login_provider_filter``, name/email prefixes).
        """
        curated: dict[str, Any] = {
            "full_text_filter": full_text_filter,
            "status_filter": status_filter,
            "workspace_ids": workspace_ids,
            "community_ids": community_ids,
            "creation_timestamp_from": to_epoch_millis(creation_timestamp_from),
            "creation_timestamp_to": to_epoch_millis(creation_timestamp_to),
            "last_access_timestamp_from": to_epoch_millis(last_access_timestamp_from),
            "last_access_timestamp_to": to_epoch_millis(last_access_timestamp_to),
            "role": role,
            "order_type_id": order_by,
            "order_desc": order_desc,
        }
        body = build_paginated_body(
            page_token=page_token,
            page_size=page_size,
            calculate_total_items_count=calculate_total_items_count,
            **{**curated, **filters},
        )
        req = ListSystemUsersRequestDTO.model_validate(body)
        return self.list_raw(req)

    def list_raw(self, req: ListSystemUsersRequestDTO) -> SystemUserList:
        """POST ``/admin/data/users`` with a pre-built request DTO (escape hatch)."""
        return SystemUserList.from_dict(
            self._post(_LIST_USERS_PATH, json=req.model_dump(mode="json", exclude_none=True))
        )

    def iterate(
        self,
        *,
        page_size: int | None = None,
        **filters: Any,
    ) -> PageIterator[generated.ListSystemUsersElementDTOModel]:
        """Lazy iterator over all pages of :meth:`list`."""

        def fetch(page_token: str | None) -> SystemUserList:
            return self.list(page_token=page_token, page_size=page_size, **filters)

        return PageIterator(fetch, items_getter=lambda page: page.items_typed)

    def me(self) -> CurrentUserResponse:
        """GET ``/core/auth/current-user-data`` — alias for :meth:`AuthAPI.current_user_data`."""
        return CurrentUserResponse.from_dict(self._get(_CURRENT_USER_PATH))

    def profile(self) -> UserProfile:
        """GET ``/core/user-profile/info`` — own profile (distinct from :meth:`me`)."""
        return UserProfile.from_dict(self._get(_PROFILE_PATH))

    def get_for_edit(self, user_id: int) -> UserForEdit:
        """GET ``/admin/manage/users/{userId}/edit`` — requires admin permissions."""
        path = _GET_FOR_EDIT_PATH.format(user_id=user_id)
        return UserForEdit.from_dict(self._get(path))

get_for_edit(user_id)

GET /admin/manage/users/{userId}/edit — requires admin permissions.

Source code in src/pynteracta/api/users.py 
132
133
134
135
def get_for_edit(self, user_id: int) -> UserForEdit:
    """GET ``/admin/manage/users/{userId}/edit`` — requires admin permissions."""
    path = _GET_FOR_EDIT_PATH.format(user_id=user_id)
    return UserForEdit.from_dict(self._get(path))

iterate(*, page_size=None, **filters)

Lazy iterator over all pages of :meth:list.

Source code in src/pynteracta/api/users.py 
111
112
113
114
115
116
117
118
119
120
121
122
def iterate(
    self,
    *,
    page_size: int | None = None,
    **filters: Any,
) -> PageIterator[generated.ListSystemUsersElementDTOModel]:
    """Lazy iterator over all pages of :meth:`list`."""

    def fetch(page_token: str | None) -> SystemUserList:
        return self.list(page_token=page_token, page_size=page_size, **filters)

    return PageIterator(fetch, items_getter=lambda page: page.items_typed)

list(*, page_token=None, page_size=None, calculate_total_items_count=None, full_text_filter=None, status_filter=None, workspace_ids=None, community_ids=None, creation_timestamp_from=None, creation_timestamp_to=None, last_access_timestamp_from=None, last_access_timestamp_to=None, role=None, order_by=None, order_desc=None, **filters)

POST /admin/data/users with curated filter and ordering kwargs.

Parameters:

Name Type Description Default
page_token str | None

Opaque token for the page to fetch.

 None
page_size int | None

Items per page.

 None
calculate_total_items_count bool | None

Ask the API to populate totalItemsCount.

 None
full_text_filter str | None

Full-text filter on name, surname, and email (fullTextFilter).

 None
status_filter list[int] | None

Filter by user status ids (statusFilter).

 None
workspace_ids list[int] | None

Filter by workspace ids (workspaceIds).

 None
community_ids list[int] | None

Filter by community ids (communityIds).

 None
creation_timestamp_from int | float | str | datetime | None

Lower bound on creation date — epoch-ms int, :class:~datetime.datetime, or ISO-8601 str (creationTimestampFrom).

 None
creation_timestamp_to int | float | str | datetime | None

Upper bound on creation date (creationTimestampTo).

 None
last_access_timestamp_from int | float | str | datetime | None

Lower bound on last-access date (lastAccessTimestampFrom).

 None
last_access_timestamp_to int | float | str | datetime | None

Upper bound on last-access date (lastAccessTimestampTo).

 None
role str | None

Filter by role (role).

 None
order_by str | None

Sort field id — mapped to orderTypeId (passthrough, no client-side validation).

 None
order_desc bool | None

Descending sort (True) or ascending (False) — orderDesc.

 None
**filters Any

Additional snake_case fields forwarded to the request body (converted to camelCase). Escape hatch for the long-tail ListSystemUsersRequestDTO fields not promoted to explicit kwargs (e.g. business_unit_ids, area_ids, manager_ids, lang, login_provider_filter, name/email prefixes).

 {}
Source code in src/pynteracta/api/users.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def list(  # noqa: PLR0913
    self,
    *,
    page_token: str | None = None,
    page_size: int | None = None,
    calculate_total_items_count: bool | None = None,
    # --- curated filters ---
    full_text_filter: str | None = None,
    status_filter: list[int] | None = None,
    workspace_ids: list[int] | None = None,
    community_ids: list[int] | None = None,
    creation_timestamp_from: int | float | str | datetime | None = None,
    creation_timestamp_to: int | float | str | datetime | None = None,
    last_access_timestamp_from: int | float | str | datetime | None = None,
    last_access_timestamp_to: int | float | str | datetime | None = None,
    role: str | None = None,
    # --- ordering ---
    order_by: str | None = None,
    order_desc: bool | None = None,
    # --- escape hatch ---
    **filters: Any,
) -> SystemUserList:
    """POST ``/admin/data/users`` with curated filter and ordering kwargs.

    Args:
        page_token: Opaque token for the page to fetch.
        page_size: Items per page.
        calculate_total_items_count: Ask the API to populate ``totalItemsCount``.
        full_text_filter: Full-text filter on name, surname, and email
            (``fullTextFilter``).
        status_filter: Filter by user status ids (``statusFilter``).
        workspace_ids: Filter by workspace ids (``workspaceIds``).
        community_ids: Filter by community ids (``communityIds``).
        creation_timestamp_from: Lower bound on creation date — epoch-ms ``int``,
            :class:`~datetime.datetime`, or ISO-8601 ``str`` (``creationTimestampFrom``).
        creation_timestamp_to: Upper bound on creation date (``creationTimestampTo``).
        last_access_timestamp_from: Lower bound on last-access date
            (``lastAccessTimestampFrom``).
        last_access_timestamp_to: Upper bound on last-access date
            (``lastAccessTimestampTo``).
        role: Filter by role (``role``).
        order_by: Sort field id — mapped to ``orderTypeId`` (passthrough, no client-side
            validation).
        order_desc: Descending sort (``True``) or ascending (``False``) — ``orderDesc``.
        **filters: Additional snake_case fields forwarded to the request body (converted to
            camelCase). Escape hatch for the long-tail ``ListSystemUsersRequestDTO`` fields
            not promoted to explicit kwargs (e.g. ``business_unit_ids``, ``area_ids``,
            ``manager_ids``, ``lang``, ``login_provider_filter``, name/email prefixes).
    """
    curated: dict[str, Any] = {
        "full_text_filter": full_text_filter,
        "status_filter": status_filter,
        "workspace_ids": workspace_ids,
        "community_ids": community_ids,
        "creation_timestamp_from": to_epoch_millis(creation_timestamp_from),
        "creation_timestamp_to": to_epoch_millis(creation_timestamp_to),
        "last_access_timestamp_from": to_epoch_millis(last_access_timestamp_from),
        "last_access_timestamp_to": to_epoch_millis(last_access_timestamp_to),
        "role": role,
        "order_type_id": order_by,
        "order_desc": order_desc,
    }
    body = build_paginated_body(
        page_token=page_token,
        page_size=page_size,
        calculate_total_items_count=calculate_total_items_count,
        **{**curated, **filters},
    )
    req = ListSystemUsersRequestDTO.model_validate(body)
    return self.list_raw(req)

list_raw(req)

POST /admin/data/users with a pre-built request DTO (escape hatch).

Source code in src/pynteracta/api/users.py 
105
106
107
108
109
def list_raw(self, req: ListSystemUsersRequestDTO) -> SystemUserList:
    """POST ``/admin/data/users`` with a pre-built request DTO (escape hatch)."""
    return SystemUserList.from_dict(
        self._post(_LIST_USERS_PATH, json=req.model_dump(mode="json", exclude_none=True))
    )

me()

GET /core/auth/current-user-data — alias for :meth:AuthAPI.current_user_data.

Source code in src/pynteracta/api/users.py 
124
125
126
def me(self) -> CurrentUserResponse:
    """GET ``/core/auth/current-user-data`` — alias for :meth:`AuthAPI.current_user_data`."""
    return CurrentUserResponse.from_dict(self._get(_CURRENT_USER_PATH))

profile()

GET /core/user-profile/info — own profile (distinct from :meth:me).

Source code in src/pynteracta/api/users.py 
128
129
130
def profile(self) -> UserProfile:
    """GET ``/core/user-profile/info`` — own profile (distinct from :meth:`me`)."""
    return UserProfile.from_dict(self._get(_PROFILE_PATH))

See also the guide Filtering and sorting users.