iter_describe_users `async` ¶

iter_describe_users(
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    organization_id: Optional[IdType] = None,
    user_ids: Optional[UserIdsType] = None,
    query: Optional[SearchQueryType] = None,
    include: Optional[UserFilterType] = None,
    order: Optional[OrderType] = None,
    sort: Optional[UserSortType] = None,
    marker: Optional[PageMarkerType] = None,
    limit: Optional[LimitType] = None,
    fields: Optional[FieldNamesType] = None,
) -> AsyncIterator[User]

Source code in docs_src/capo_workdocs/_services/async_work_docs.py

async def iter_describe_users(
    self,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    organization_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    user_ids: Optional["capo_workdocs.types.user_ids_type.UserIdsType"] = None,
    query: Optional["capo_workdocs.types.search_query_type.SearchQueryType"] = None,
    include: Optional["capo_workdocs.types.user_filter_type.UserFilterType"] = None,
    order: Optional["capo_workdocs.types.order_type.OrderType"] = None,
    sort: Optional["capo_workdocs.types.user_sort_type.UserSortType"] = None,
    marker: Optional["capo_workdocs.types.page_marker_type.PageMarkerType"] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    fields: Optional["capo_workdocs.types.field_names_type.FieldNamesType"] = None,
) -> "AsyncIterator[capo_workdocs.types.user.User]":
    _token = marker
    while True:
        _response = await self.describe_users(
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            organization_id=organization_id,
            user_ids=user_ids,
            query=query,
            include=include,
            order=order,
            sort=sort,
            marker=_token,
            limit=limit,
            fields=fields,
        )
        _page = _resolve_path(_response, ("users",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break

iter_describe_users async ¶

iter_describe_users `async` ¶