agilicus 1.286.5__py3-none-any.whl → 1.287.1__py3-none-any.whl

agilicus/agilicus_api/api_client.py

@@ -77,7 +77,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.286.5/python'
+        self.user_agent = 'OpenAPI-Generator/1.287.1/python'
 
     def __enter__(self):
         return self

agilicus/agilicus_api/configuration.py

@@ -387,7 +387,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2025.04.17\n"\
-               "SDK Package Version: 1.286.5".\
+               "SDK Package Version: 1.287.1".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

agilicus/agilicus_api_README.md

@@ -4,7 +4,7 @@ Agilicus is API-first. Modern software is controlled by other software, is open,
 The `agilicus_api` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2025.04.17
-- Package version: 1.286.5
+- Package version: 1.287.1
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.agilicus.com/api](https://www.agilicus.com/api)
 

agilicus/main.py

@@ -5222,6 +5222,23 @@ def list_api_keys(ctx, scope, **kwargs):
         output_entry(ctx, page_details)
 
 
+@cli.command(name="clean-api-keys")
+@click.option("--user-id", type=str, default=None)
+@click.option("--org-id", type=str, default=None)
+@click.option("--expires-at", type=custom_types.DateTime(), default=None)
+@click.option("--no-expiry", is_flag=True, default=None)
+@click.option("--older-than", type=custom_types.DateTime(), default=None)
+@click.pass_context
+def clear_api_keys(ctx, **kwargs):
+    api_keys = tokens.clean_api_keys(ctx, **kwargs)
+    if context.output_json(ctx):
+        output_formatted(ctx, api_keys)
+        return
+
+    table = tokens.format_api_keys_as_text(ctx, api_keys)
+    print(table)
+
+
 @cli.command(name="show-api-key-introspection")
 @click.argument("email")
 @click.argument("api_key")

agilicus/pagination/pagination.py

@@ -1,3 +1,5 @@
+import inspect
+
 from typing import Callable
 
 
@@ -7,6 +9,7 @@ def get_many_entries(
     page_size=100,
     maximum=None,
     page_callback=None,
+    page_key="page_at_id",
     **kwargs,
 ):
     """Implements the generic pagination strategy
@@ -20,25 +23,39 @@ def get_many_entries(
     if "limit" in kwargs:
         del kwargs["limit"]
     kwargs["limit"] = page_size
-    if "page_at_id" not in kwargs:
-        kwargs["page_at_id"] = ""
+    if page_key not in kwargs:
+        kwargs[page_key] = ""
+
+    retval = []
+
+    def apply_page(page):
+        retval.extend(page)
+        if not page_callback:
+            return
+        if len(inspect.getfullargspec(page_callback).args) > 0:
+            page_callback(page=page)
+            return
+
+        page_callback()
 
     list_resp = api_func(**kwargs)
-    retval = list_resp.get(response_list_key) or []
+    page_items = list_resp.get(response_list_key) or []
+    apply_page(page_items)
+
     # loop quits when the list is < the page_size
     while len(list_resp.get(response_list_key, [])) >= page_size and _list_at_max_size(
         len(retval), maximum
     ):
-        page_at_id = list_resp.get("page_at_id", None)
+        page_at_id = list_resp.get(page_key, None)
         if page_at_id is None:
             raise Exception(
-                "page_at_id cannot be None for pagination to continue processing"
+                f"{page_key} cannot be None for pagination to continue processing"
             )
-        kwargs["page_at_id"] = list_resp.get("page_at_id", None)
+        kwargs[page_key] = list_resp.get(page_key, None)
         list_resp = api_func(**kwargs)
-        retval.extend(list_resp.get(response_list_key, []))
-        if page_callback:
-            page_callback()
+        page_items = list_resp.get(response_list_key, [])
+        apply_page(page_items)
+
     return _get_max_retval(retval, maximum)
 
 

agilicus/pagination/pagination_test.py

@@ -0,0 +1,93 @@
+from .pagination import get_many_entries
+
+
+class fakeAPI:
+    def __init__(self, item_key, page_key, start_page=""):
+        self.item_key = item_key
+        self.page_key = page_key
+        self.pages = {}
+        self.next_page = start_page
+
+    def _make_page(self, items, next_page):
+        return {
+            "limit": len(items),
+            self.item_key: items,
+            self.page_key: next_page,
+        }
+
+    def add_page(self, items, next_page):
+        self.pages[self.next_page] = self._make_page(items, next_page)
+
+        self.next_page = next_page
+
+    def do_list(self, **kwargs):
+        page = kwargs[self.page_key]
+        result = self.pages.get(page)
+        if not result:
+            return self._make_page([], page)
+        return result
+
+
+def make_test_page(items, item_key, page_key, next_page):
+    return {
+        "limit": len(items),
+        item_key: items,
+        page_key: next_page,
+    }
+
+
+def test_get_many_entries_gets_all():
+    api = fakeAPI("items", "page_at_id")
+    api.add_page([10, 8, 6], 6)
+    api.add_page([4, 3, 2], 2)
+    api.add_page([1, 0], 0)
+
+    result = get_many_entries(api.do_list, api.item_key, page_size=3)
+    assert [10, 8, 6, 4, 3, 2, 1, 0] == result
+
+
+def test_get_many_entries_limits_to_max():
+    api = fakeAPI("items", "page_at_id")
+    api.add_page([10, 8, 6], 6)
+    api.add_page([4, 3, 2], 2)
+    api.add_page([1, 0], 0)
+
+    result = get_many_entries(api.do_list, api.item_key, page_size=3, maximum=4)
+    assert [10, 8, 6, 4] == result
+
+
+def test_get_many_entries_invokes_callback():
+    api = fakeAPI("items", "page_at_id")
+    api.add_page([10, 8, 6], 6)
+    api.add_page([4, 3, 2], 2)
+    api.add_page([1, 0], 0)
+
+    calls = []
+
+    def callback():
+        calls.append(None)
+
+    result = get_many_entries(
+        api.do_list, api.item_key, page_size=3, page_callback=callback
+    )
+    assert [10, 8, 6, 4, 3, 2, 1, 0] == result
+    assert len(calls) == 3
+
+
+def test_get_many_entries_invokes_callback_with_page():
+    api = fakeAPI("items", "page_at_id")
+    api.add_page([10, 8, 6], 6)
+    api.add_page([4, 3, 2], 2)
+    api.add_page([1, 0], 0)
+
+    calls = []
+
+    def callback(page):
+        calls.append(page)
+
+    result = get_many_entries(
+        api.do_list, api.item_key, page_size=3, page_callback=callback
+    )
+    assert [10, 8, 6, 4, 3, 2, 1, 0] == result
+
+    assert [[10, 8, 6], [4, 3, 2], [1, 0]] == calls

agilicus/tokens.py

@@ -3,6 +3,7 @@ import json
 import urllib.parse
 import datetime
 import jwt
+import sys
 
 import requests
 import agilicus
@@ -13,6 +14,7 @@ from .input_helpers import get_user_id_from_input_or_ctx
 from .input_helpers import build_updated_model
 from .input_helpers import strip_none
 from .input_helpers import update_if_present
+from .pagination import pagination
 
 from .output import output_if_console
 
@@ -595,3 +597,59 @@ def update_session_challenge(ctx, token=None):
     apiclient = context.get_apiclient_from_ctx(ctx, token=token)
     body = agilicus.SessionChallenge()
     return apiclient.tokens_api.update_session_challenge(body)
+
+
+def clean_api_keys(
+    ctx, expires_at=None, no_expiry=False, older_than=None, max_failures=5, **kwargs
+):
+    apiclient = context.get_apiclient_from_ctx(ctx)
+    update_org_from_input_or_ctx(kwargs, ctx, **kwargs)
+    kwargs["user_id"] = get_user_id_from_input_or_ctx(ctx, **kwargs)
+    kwargs = strip_none(kwargs)
+    to_delete = []
+
+    def should_delete(api_key):
+        if older_than is not None and api_key.metadata.created >= older_than:
+            return False
+
+        if api_key.spec.expiry is None:
+            return no_expiry
+
+        if expires_at is not None:
+            return api_key.spec.expiry < expires_at
+
+        return False
+
+    def deleter(page: list):
+        for api_key in page:
+            if should_delete(api_key):
+                to_delete.append(api_key)
+
+    pagination.get_many_entries(
+        apiclient.tokens_api.list_api_keys,
+        "api_keys",
+        100,
+        None,
+        page_callback=deleter,
+        page_key="page_at_created_date",
+        page_at_created_date=None,
+        sort_order="descending",
+        search_direction="forwards",
+        **kwargs,
+    )
+    failures = 0
+    deleted = []
+    for key in to_delete:
+        token_id = key.metadata.id
+        org_id = key.spec.org_id
+        try:
+            apiclient.tokens_api.delete_api_key(token_id, org_id=org_id)
+        except Exception as exc:
+            print(f"failed deleting {token_id}: {exc}", file=sys.stderr)
+            failures += 1
+        if failures >= max_failures:
+            print("too many failures. Exiting early", file=sys.stderr)
+            return
+        deleted.append(key)
+
+    return deleted

{agilicus-1.286.5.dist-info → agilicus-1.287.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: agilicus
-Version: 1.286.5
+Version: 1.287.1
 Summary: Agilicus SDK
 Home-page: https://www.agilicus.com/
 License: MIT

{agilicus-1.286.5.dist-info → agilicus-1.287.1.dist-info}/RECORD

@@ -71,9 +71,9 @@ agilicus/agilicus_api/api/users_api.py,sha256=vc1a6U7o4Pg_2A_FjPVIpiyRTIREZ58jpt
 agilicus/agilicus_api/api/users_api_mock.py,sha256=aMSUc12JQAo1O9rp2YnyQldANFGlfi57fMnQyCIrJuE,17209
 agilicus/agilicus_api/api/whoami_api.py,sha256=RNGWCYPit1iT7qrxDdOzyIKJkIdMuDryyKVmoxeg0qI,7941
 agilicus/agilicus_api/api/whoami_api_mock.py,sha256=rlvZoWnMCqORMZBg7SOv6d3xp52kELdh6wXcCaIZ93w,346
-agilicus/agilicus_api/api_client.py,sha256=T5vili8FQNaoOxChKKHk4Gap80buY93CAvMM_7RlqiE,38845
+agilicus/agilicus_api/api_client.py,sha256=WZ4wYE6o-RY7hhg_bhPGA2qPI_k-qvyuuTaI5Vjqejs,38845
 agilicus/agilicus_api/apis/__init__.py,sha256=aJZD7x-umdSni6ZBr4XxzpH8pwtU9hA5LlCDxcqa1Q8,2224
-agilicus/agilicus_api/configuration.py,sha256=EuN3HdkIbSc_7_Ny14AqVCSTvtv5g5qs-K97tKrzRU8,18447
+agilicus/agilicus_api/configuration.py,sha256=6gnetAAoozBXZHwaunB0P2fotR1u0uKZ2rX39-Oh6zU,18447
 agilicus/agilicus_api/docs/APIKey.md,sha256=4cKuz4_l9HcEDnUrLwYbEnn9C2WoDayrjfrY1Ixgaf4,1747
 agilicus/agilicus_api/docs/APIKeyIntrospect.md,sha256=nJ-zkuFm3JMbWFDYYN_vYyQk1snGBtBvIxtCQxamhAU,1019
 agilicus/agilicus_api/docs/APIKeyIntrospectAuthorizationInfo.md,sha256=7RApOOLjvWQs5sw2jb25g7i3Kta1BiEY-s8VRXfppH8,725
@@ -2667,7 +2667,7 @@ agilicus/agilicus_api/test/test_x509_root_certificate.py,sha256=LV5_rQa2jhob7DzH
 agilicus/agilicus_api/test/test_x509_root_certificate_spec.py,sha256=_csieI3dVbNe1oyoXCMPytlRUkatdg3rqVHNUASODf0,2832
 agilicus/agilicus_api/test/test_x509_root_certificate_status.py,sha256=0vDt4PephnpGCV7pw8JSOcvJ9ifukwyE5zYlFFF-Z7c,2846
 agilicus/agilicus_api/test/test_xss_settings.py,sha256=naM6PzbbiE5gF030lL5Ci5zfFcT-CVJzYZdMS9UNM8A,2746
-agilicus/agilicus_api_README.md,sha256=rDP9fdfxkx5Hzpzu_asZeEWctuJTsEZkoW4q4CtY2Ww,171736
+agilicus/agilicus_api_README.md,sha256=-Z5nxFclI4EfIcyfDgZNGDTuuWhpFN2yX2abQipR11M,171736
 agilicus/aliases.ini,sha256=MxqiVo2f2xdUDVF1YDkNW36AIqN8hrYjlTVfraEUZXY,455
 agilicus/amq.py,sha256=yxi-YTbJPVl10s78Hlr1dmrQR63iaSIoROGVILzFPmE,1775
 agilicus/apps.py,sha256=Mdc_pRXyfa-IvIFH7gNbx0Ob64gUHggZyeSyLUDpjMs,54048
@@ -2722,7 +2722,7 @@ agilicus/labels/labels_main.py,sha256=l2z_41X3sMJoSM483LmAzJE6bKKHVAEvrPjfz7QvFg
 agilicus/launchers.py,sha256=r4nctnVtfP-Ho_HXEfAiMaMqJI0u7pbieHSS3Vd0QBE,11361
 agilicus/logs.py,sha256=Y4XVcLctY-2O-Q_CXbJs9sAqu0NknHKSsqilKiDM_A0,804
 agilicus/lookups.py,sha256=MNmNsKpP7Fq_poLAnL9xo_iptFilKM9ziGLyIe8VKaw,669
-agilicus/main.py,sha256=vBoTqK9_r6TvwmeayEjIBgJtGHqdE59HT553v6W3NwU,289375
+agilicus/main.py,sha256=PvQ_Hmmy4qI83q0_7PeGECHm01Xhbq5qo8nKHQyV8rs,289990
 agilicus/messages/__init__.py,sha256=cVqfaKUndO-AYfppkdFICM5WvYFFB1hRjXihFWmiGPQ,174
 agilicus/messages/messages.py,sha256=b2eO6BaWI9UZTLETcdy1NotyuNlKIJf6CS_TUzehuk4,9175
 agilicus/messages/messages_main.py,sha256=A0xucYwwUZFIuUc0bAyAqVwofErakmyawq5bwhZKcOU,1598
@@ -2735,7 +2735,9 @@ agilicus/output/json.py,sha256=-5bX7ud1hIxux4l3P-K2gJXrE2gdZ0Ua1hfUOCX9MUM,899
 agilicus/output/table.py,sha256=o5kYgAtIAhei4ex7YZrTK9tDVarJQHzF2Yj42TXt21g,8744
 agilicus/output/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 agilicus/output/tests/column_builder_test.py,sha256=fKP4V5sqXtmEIr-Q0gWVSFdBqCUtugZkP6G5gML_T7I,2130
-agilicus/pagination/pagination.py,sha256=hC7eLHxXKe4Iv7LdOZK3Dh8R_fKQIr9PPiWKJVyP4Nk,1672
+agilicus/pagination/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+agilicus/pagination/pagination.py,sha256=4OcBy0kC7J4r3ofEBrYX4ZvCoDpUXTSxHHpsuVwPTJs,1970
+agilicus/pagination/pagination_test.py,sha256=f28x57SoBz9xGp8Go1k-77Fvzbz9c2HPVeNlxkNcsK8,2409
 agilicus/patches.py,sha256=qTqLOgCAcFZPcPOkgfqMnK9bnqTXMvj_0ERsjRFcZug,1384
 agilicus/permissions.py,sha256=uB65yuDFICp1N10m0cdUjgizx9MQzAbLbAsBSTw1Rcc,2117
 agilicus/policy/policies.py,sha256=eAy1iRlYKvkuc-10ssw_iuchY-I24LvtHiruvyzo5Pg,11440
@@ -2760,15 +2762,15 @@ agilicus/ssh.py,sha256=mVqMlDM2zAcUphehyz9djXjrRPSIxR1qJr2Ehvl3Rvw,2925
 agilicus/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 agilicus/tests/keyring_test.py,sha256=Uwp2VS2_NffYBgHAS9bXuXnIxRoK0_VOWaaYCZKv0lg,1452
 agilicus/tests/test_pop_utils.py,sha256=gdSMOmE0pNSDA0UgUWdbLKpFzUGwfBwkFSrk1p1JdSo,1083
-agilicus/tokens.py,sha256=H3_hSNUmyDeidCndQ_rlxqAaliAFIpNDJ1vW-fynwhs,18828
+agilicus/tokens.py,sha256=0zckgaZxYF8PFNBhUnV6yrrmVGru3dmh1qSH6YZQhsE,20515
 agilicus/transfers.py,sha256=PYr_fW7dyXNUXzi5Wp5mUjZOvU7MbRzoN-D8Omo-YSQ,1523
 agilicus/trusted_certs/trusted_certs.py,sha256=HCAvYxOA3ooaee2_KbYJd6Yt_dxDEn8hjhy1upVJUYE,7951
 agilicus/trusted_certs/trusted_certs_main.py,sha256=6dHHWXvNIcUa_nA9ptigL4Vibe4nB2wnWFTTJ8AOgXo,5155
 agilicus/users.py,sha256=bUFtVlTjUeEoQlzsQcfS8ChN0X9mbHs8v0xbkK-cldQ,41772
 agilicus/version.py,sha256=G9OFdL1v_4dLDfk6I6taDNypM5bbO-JHAwilsu9LYgg,23
 agilicus/whoami.py,sha256=kqghtWMgZOd2rhKmfguDwCTm6A3gNS8Kj-S2IBxBtl0,206
-agilicus-1.286.5.dist-info/LICENSE.txt,sha256=Zq4tqiCroC2CVrBB_PWjapRdvpae23nljdiaSkOzUho,1061
-agilicus-1.286.5.dist-info/METADATA,sha256=VN1cwLZeUoswkCJXSGlw6pKjPuLg4lQIApZN4uNaxy4,3878
-agilicus-1.286.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-agilicus-1.286.5.dist-info/entry_points.txt,sha256=a66hGozzLkHu0IewFzIMbSAhMTNTddUaA2T3_16Gb_s,51
-agilicus-1.286.5.dist-info/RECORD,,
+agilicus-1.287.1.dist-info/LICENSE.txt,sha256=Zq4tqiCroC2CVrBB_PWjapRdvpae23nljdiaSkOzUho,1061
+agilicus-1.287.1.dist-info/METADATA,sha256=PWk0MyfBdFFkjNo85KaMnBDwOc8YrmDPkfeJCjGTINw,3878
+agilicus-1.287.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+agilicus-1.287.1.dist-info/entry_points.txt,sha256=a66hGozzLkHu0IewFzIMbSAhMTNTddUaA2T3_16Gb_s,51
+agilicus-1.287.1.dist-info/RECORD,,