Skip to content

Base Client

BaseAPIClient is the shared foundation for every SDK client. BrowsingAPI, UserManagementAPI, OrgManagementAPI, FileAPI, LogExtractionAPI, and HarvesterAPI all subclass it, so the members documented here are available on each of them in addition to their own methods.

You rarely instantiate BaseAPIClient directly. Its members matter for three things: the configuration keys every client reads, batching several wire commands into one request, and building the TLS context used by the SDK's async paths.

See Configuration for the full settings list, Authentication for token setup, Async Support for the async methods that consume the SSL context, and Wire Protocol for the command-array format batch_request() accepts.

Base API client for Authentic8 Silo platform APIs.

Every SDK client — BrowsingAPI, UserManagementAPI, OrgManagementAPI, FileAPI, LogExtractionAPI and HarvesterAPI — subclasses this class, so the members documented here are available on all of them. It provides:

  • HTTP session management with retry logic for idempotent methods
  • Authentication handling (the setauth command is injected for you)
  • Request and response logging, with credential-bearing values redacted
  • Error handling and exception mapping onto the SiloError hierarchy
  • Rate limit handling, including Retry-After

You normally instantiate a subclass rather than this class directly. Use it as a context manager so the underlying HTTP session is always closed.

Attributes:

Name Type Description
config

Configuration dictionary the client was built from.

session

requests.Session used for all synchronous requests.

base_url

Base URL for API endpoints (API_URL, defaulting to https://extapi.authentic8.com).

timeout

Request timeout in seconds (REQUEST_TIMEOUT).

max_retries

Maximum retry attempts for idempotent requests (MAX_RETRIES).

retry_delay

The configured RETRY_DELAY value in seconds. Stored for callers that want it; no shipped SDK code reads it. The synchronous session retries with urllib3 exponential backoff and the async paths compute their own backoff, so neither consults this value.

logger

The shared silo_sdk logger, set to LOG_LEVEL.

Examples:

>>> from silo_sdk import UserManagementAPI, load_config
>>> config = load_config()
>>> with UserManagementAPI(config) as api:
...     users = api.list_users(org=config["TOP_ORG"])
Source code in silo_sdk/base/api_client.py
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
class BaseAPIClient:
    """Base API client for Authentic8 Silo platform APIs.

    Every SDK client — ``BrowsingAPI``, ``UserManagementAPI``,
    ``OrgManagementAPI``, ``FileAPI``, ``LogExtractionAPI`` and
    ``HarvesterAPI`` — subclasses this class, so the members documented here
    are available on all of them. It provides:

    - HTTP session management with retry logic for idempotent methods
    - Authentication handling (the ``setauth`` command is injected for you)
    - Request and response logging, with credential-bearing values redacted
    - Error handling and exception mapping onto the ``SiloError`` hierarchy
    - Rate limit handling, including ``Retry-After``

    You normally instantiate a subclass rather than this class directly. Use
    it as a context manager so the underlying HTTP session is always closed.

    Attributes:
        config: Configuration dictionary the client was built from.
        session: ``requests.Session`` used for all synchronous requests.
        base_url: Base URL for API endpoints (``API_URL``, defaulting to
            ``https://extapi.authentic8.com``).
        timeout: Request timeout in seconds (``REQUEST_TIMEOUT``).
        max_retries: Maximum retry attempts for idempotent requests
            (``MAX_RETRIES``).
        retry_delay: The configured ``RETRY_DELAY`` value in seconds. Stored
            for callers that want it; no shipped SDK code reads it. The
            synchronous session retries with urllib3 exponential backoff and
            the async paths compute their own backoff, so neither consults
            this value.
        logger: The shared ``silo_sdk`` logger, set to ``LOG_LEVEL``.

    Examples:
        >>> from silo_sdk import UserManagementAPI, load_config
        >>> config = load_config()
        >>> with UserManagementAPI(config) as api:
        ...     users = api.list_users(org=config["TOP_ORG"])
    """

    def __init__(self, config: dict[str, Any]) -> None:
        """Initialize the base API client.

        Reads the following keys from ``config``; every one of them is
        optional and falls back to the default shown:

        | Key | Default | Purpose |
        |---|---|---|
        | ``API_URL`` | ``https://extapi.authentic8.com`` | Base URL for all requests |
        | ``REQUEST_TIMEOUT`` | ``30`` | Per-request timeout in seconds |
        | ``MAX_RETRIES`` | ``3`` | Retry attempts for idempotent methods |
        | ``RETRY_DELAY`` | ``5`` | Stored on the client; not read by the SDK |
        | ``LOG_LEVEL`` | ``INFO`` | Level for the shared ``silo_sdk`` logger |
        | ``USER_AGENT`` | SDK default | ``User-Agent`` header sent on every request |
        | ``PROXY`` | unset | Proxy mapping passed through to ``requests`` |
        | ``ENABLE_REQUEST_LOGGING`` | ``False`` | Log each request's commands, redacted |

        Subclasses add their own required keys — most importantly the API
        token for the surface they talk to. See the Configuration guide for
        the full list and the matching ``A8_*`` environment variables.

        ``API_URL`` must use ``https``. Every request carries an API token in
        its payload, so a plaintext URL would disclose that token; plain
        ``http`` is accepted only against loopback for local testing, and a
        URL with embedded ``user:password@`` credentials is always rejected.

        Args:
            config: Configuration dictionary containing API settings.

        Raises:
            ConfigurationError: If ``config`` is not a dictionary, or
                ``API_URL`` is not a string, embeds credentials, or uses a
                scheme other than ``https`` (or ``http`` against loopback).
        """
        self.config = config

        # Setup logging first so it can be used in validation
        log_level = (
            config.get("LOG_LEVEL", "INFO") if isinstance(config, dict) else "INFO"
        )
        self.logger = self._setup_logger(log_level)

        self._validate_config()

        self.base_url = config.get("API_URL", "https://extapi.authentic8.com")
        self.timeout = config.get("REQUEST_TIMEOUT", 30)
        self.max_retries = config.get("MAX_RETRIES", 3)
        self.retry_delay = config.get("RETRY_DELAY", 5)
        self.enable_request_logging = _config_flag(
            config.get("ENABLE_REQUEST_LOGGING", False)
        )

        # Setup HTTP session
        self.session = self._setup_session()

        self.logger.info("Initialized %s", self.__class__.__name__)

    def _validate_config(self) -> None:
        """Validate the configuration dictionary.

        Raises:
            ConfigurationError: If required configuration is missing
        """
        if not isinstance(self.config, dict):
            raise ConfigurationError("Configuration must be a dictionary")

        # Base validation - subclasses should override for specific requirements
        api_url = self.config.get("API_URL")
        if not api_url:
            self.logger.warning("API_URL not specified, using default")
        else:
            self._validate_api_url(api_url)

    def _validate_api_url(self, api_url: Any) -> None:
        """Reject an API_URL that would send bearer tokens in the clear.

        Every request carries a ``setauth`` command whose payload is a
        long-lived API token. Over ``http://`` that token is readable by
        anything on the path, so a mistyped or copy-pasted plaintext URL is
        a credential disclosure rather than a connectivity problem. Loopback
        is allowed because that is how a local mock or a proxy under test is
        addressed, and the traffic never leaves the host.

        Args:
            api_url: The configured ``API_URL`` value.

        Raises:
            ConfigurationError: If the URL is not a string, carries embedded
                credentials, or uses a scheme other than https (or http
                against loopback).
        """
        if not isinstance(api_url, str):
            raise ConfigurationError(
                f"API_URL must be a string, got {type(api_url).__name__}"
            )

        parsed = urlparse(api_url)

        # Embedded credentials end up in `response.url`, which httpx renders
        # unmasked in HTTPStatusError messages -- so a copy-pasted
        # https://user:pass@host would leak the password into every error
        # string and request log. This API authenticates with `setauth`, not
        # with userinfo, so there is no legitimate use for it here.
        if parsed.username or parsed.password:
            raise ConfigurationError(
                "API_URL must not embed credentials (user:password@host). "
                "They would be written to logs and error messages verbatim, "
                "and this API authenticates with tokens instead -- set the "
                "relevant A8_*_TOKEN value and give API_URL only the host."
            )

        if parsed.scheme == "https":
            return

        hostname = (parsed.hostname or "").lower()
        if parsed.scheme == "http" and hostname in _LOOPBACK_HOSTS:
            self.logger.warning(
                "API_URL uses plaintext http against loopback (%s). This is "
                "accepted for local testing only -- API tokens are sent "
                "unencrypted.",
                api_url,
            )
            return

        raise ConfigurationError(
            f"API_URL must use https, got {api_url!r}. Every request carries an "
            "API token in its payload, so a plaintext scheme would disclose it. "
            "Plain http is accepted only against loopback (127.0.0.1, localhost, "
            "::1) for local testing."
        )

    @staticmethod
    def _setup_logger(log_level: str) -> logging.Logger:
        """Setup logger for the API client.

        Args:
            log_level: Logging level (DEBUG, INFO, WARNING, ERROR)

        Returns:
            Configured logger instance
        """
        logger_instance = logging.getLogger("silo_sdk")

        # Only furnish a handler when nothing else has. The check used to look
        # at this logger alone, so an application that had already called
        # logging.basicConfig() got two: ours on "silo_sdk", theirs on the root
        # the record then propagates to. Every SDK line came out twice, in two
        # different formats -- visible in the MCP container, which configures
        # root logging at startup, and in any host application that does the
        # same. A library attaching a handler unconditionally is the cause; the
        # standard courtesy is to defer to whoever configured logging and only
        # step in when nobody has, so a plain SDK script still gets output.
        if not logger_instance.handlers and not logging.getLogger().handlers:
            handler = logging.StreamHandler()
            formatter = logging.Formatter(
                "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
            )
            handler.setFormatter(formatter)
            logger_instance.addHandler(handler)

        logger_instance.setLevel(getattr(logging, log_level.upper(), logging.INFO))
        return logger_instance

    def _setup_session(self) -> requests.Session:
        """Setup HTTP session with retry logic and configuration.

        Returns:
            Configured requests session
        """
        session = requests.Session()

        # Setup retry strategy.
        #
        # Only idempotent HTTP methods are retried. Every mutating extapi
        # command (adduser, reset_pin, org.create, org.delete, batch
        # operations, etc.) is sent as POST — transparently retrying a POST
        # on a transient 429/500/502/503/504 risks re-executing a
        # non-idempotent side effect (e.g. duplicate user creation, or a
        # second reset_pin temp-password email) if the original request
        # actually succeeded server-side before the error response reached
        # the client. Retries for non-idempotent methods, if wanted, belong
        # at a caller layer that can deduplicate. See GH issue #37.
        retry_strategy = Retry(
            total=self.max_retries,
            backoff_factor=1,
            status_forcelist=[429, 500, 502, 503, 504],
            allowed_methods=[
                "GET",
                "HEAD",
                "PUT",
                "DELETE",
                "OPTIONS",
            ],
        )

        adapter = HTTPAdapter(max_retries=retry_strategy)
        session.mount("https://", adapter)

        # Set default headers
        session.headers.update(
            {
                "Accept": "application/json",
                "Content-Type": "application/json",
                "User-Agent": self.config.get("USER_AGENT", DEFAULT_USER_AGENT),
            }
        )

        # Setup proxy if configured
        proxy_config = self.config.get("PROXY")
        if proxy_config:
            session.proxies.update(proxy_config)

        return session

    def _log_request(
        self,
        method: str,
        url: str,
        payload: list[dict[str, Any]] | None,
        auth_token: str,
    ) -> None:
        """Log one outbound request at INFO, with credentials removed.

        Gated on ``ENABLE_REQUEST_LOGGING``. This is a separate switch from
        ``LOG_LEVEL`` on purpose: it answers "which commands did the SDK
        send, with which parameters", which is the question you have when
        reconciling SDK behavior against the API, and you should not have to
        turn on every ``DEBUG`` line in the SDK to get it.

        Credentials are removed twice over. :func:`_redact_for_log` masks
        secret-bearing fields structurally, and the rendered string then has
        the token literal replaced -- so a token reaching the log would
        require both a payload shape the structural pass does not recognize
        *and* a value that is not the token we were handed.

        Request only: responses are deliberately not logged here. Response
        bodies carry user records, file contents and log extracts, which is
        a data-classification decision rather than a debugging one, and it
        should not ride along on a flag named for requests.

        Args:
            method: HTTP method, for display.
            url: Fully-resolved request URL.
            payload: The command array about to be sent, if any.
            auth_token: The token to scrub from the rendered output. Never
                logged.
        """
        if payload is None:
            self.logger.info("API request: %s %s (no payload)", method.upper(), url)
            return

        try:
            rendered = json.dumps(_redact_for_log(payload), default=str)
        except (TypeError, ValueError):  # pragma: no cover - defensive
            # A payload that cannot be serialized must not take the request
            # down; the request itself would fail on its own json.dumps and
            # report a far better error than this logging path could.
            self.logger.info(
                "API request: %s %s (payload not renderable)", method.upper(), url
            )
            return

        # Belt and braces over the structural redaction above: if the token
        # survived in a field this function does not know about, remove it by
        # value. Guarded on a non-empty token so an unauthenticated request
        # does not turn every empty string in the payload into a placeholder.
        if auth_token:
            rendered = rendered.replace(auth_token, _REDACTED)

        self.logger.info("API request: %s %s payload=%s", method.upper(), url, rendered)

    def _make_api_request(
        self,
        method: str,
        endpoint: str,
        auth_token: str,
        payload: list[dict[str, Any]] | None = None,
        **kwargs: Any,
    ) -> list[dict[str, Any]]:
        """Make an API request to the Authentic8 platform.

        Args:
            method: HTTP method (GET, POST, etc.)
            endpoint: API endpoint path
            auth_token: Authentication token
            payload: Request payload for POST requests
            **kwargs: Additional arguments passed to requests

        Returns:
            API response data

        Raises:
            AuthenticationError: If authentication fails
            RateLimitError: If rate limit is exceeded
            SiloError: For other API errors
        """
        url = urljoin(self.base_url, endpoint.lstrip("/"))

        # Setup authentication
        headers = kwargs.pop("headers", {})
        if auth_token:
            headers["X-Auth"] = auth_token

        # Prepare request data
        request_data = None
        if payload is not None:
            # Add auth command if not already present
            if not any(cmd.get("command") == "setauth" for cmd in payload):
                payload.insert(0, {"command": "setauth", "data": auth_token})
            request_data = json.dumps(payload)

        # Log request (without sensitive data)
        self.logger.debug(
            "Making %s request to %s",
            method.upper(),
            url,
        )

        if self.enable_request_logging:
            self._log_request(method, url, payload, auth_token)

        try:
            response = self.session.request(
                method=method,
                url=url,
                data=request_data,
                headers=headers,
                timeout=self.timeout,
                **kwargs,
            )

            # Log response
            self.logger.debug(
                "Received response: %s %s",
                response.status_code,
                response.reason,
            )

            # Handle response
            return self._handle_response(response)

        except requests.exceptions.Timeout as e:
            raise SiloError(f"Request timeout after {self.timeout}s") from e
        except requests.exceptions.ConnectionError as e:
            raise SiloError(f"Connection error: {e}") from e
        except requests.exceptions.RequestException as e:
            raise SiloError(f"Request failed: {e}") from e

    def _handle_response(self, response: requests.Response) -> list[dict[str, Any]]:
        """Handle API response and extract data.

        Args:
            response: HTTP response object

        Returns:
            Parsed response data

        Raises:
            AuthenticationError: If authentication fails
            RateLimitError: If rate limit is exceeded
            SiloError: For other API errors
        """
        # Extract request ID if available
        request_id = response.headers.get("X-Request-ID")

        # Handle rate limiting
        if response.status_code == 429:
            retry_after = _parse_retry_after(response.headers.get("Retry-After"))
            raise RateLimitError(
                "Rate limit exceeded",
                status_code=response.status_code,
                request_id=request_id,
                retry_after=retry_after,
            )

        # Handle authentication errors
        if response.status_code == 401:
            raise _auth_error(response, request_id)

        # Handle other HTTP errors
        if not response.ok:
            try:
                error_data = response.json()
            except (ValueError, json.JSONDecodeError):
                error_data = {"error": response.text}

            raise SiloError(
                f"API request failed: {response.status_code} {response.reason}",
                status_code=response.status_code,
                response_data=error_data,
                request_id=request_id,
            )

        # Parse response
        try:
            raw_data: Any = response.json()
        except (ValueError, json.JSONDecodeError) as e:
            raise SiloError(f"Invalid JSON response: {e}") from e

        # Ensure data is a list (Authentic8 API returns arrays)
        if isinstance(raw_data, list):
            data: list[dict[str, Any]] = raw_data
        else:
            data = [raw_data]

        return data

    @api_tag(MethodType.UTILITY)
    def batch_request(
        self,
        commands: list[dict[str, Any]],
        auth_token: str,
    ) -> list[dict[str, Any]]:
        """Execute multiple wire-format commands in a single batch POST.

        Sends every command to the Authentic8 API in a single HTTP round trip
        instead of one request per command. The ``setauth`` command is
        injected automatically — do not include it.

        Unlike the single-command methods on the API subclasses, per-item
        errors in the response are **not** raised as exceptions. Each result
        dict may contain either a ``"result"`` key (success) or an
        ``"error"`` key (failure for that one command), and the caller is
        responsible for inspecting individual results. Only failures of the
        HTTP request as a whole raise.

        The response is positional: results come back in the order the
        commands were submitted. A short list means the server did not return
        a result for every command — treat a missing entry as "no response
        received" rather than as success.

        Args:
            commands: Non-empty list of command dicts. Each must have a
                ``"command"`` key with params flat alongside it. Do not
                include ``setauth``.
            auth_token: Authentication token to use for the batch.

        Returns:
            List of result dicts, one per submitted command (the ``setauth``
                acknowledgment at index 0 is stripped).

        Raises:
            ValidationError: If ``commands`` is empty, any command is missing
                the ``"command"`` key, or any command is ``setauth``.
            SiloError: If the HTTP request itself fails (timeout, connection
                error, non-200 status code).

        Examples:
            >>> client = BaseAPIClient(config)
            >>> results = client.batch_request(
            ...     [
            ...         {"command": "listusers", "org": "MyOrg"},
            ...         {"command": "deleteuser", "username": "u@co.com"},
            ...     ],
            ...     auth_token=config["SYNC_TOKEN"],
            ... )
            >>> for r in results:
            ...     print(r.get("result") or r.get("error"))
        """
        if not commands:
            raise ValidationError("commands must be a non-empty list")

        for i, cmd in enumerate(commands):
            if not isinstance(cmd, dict) or "command" not in cmd:
                raise ValidationError(
                    f"commands[{i}] must be a dict with a 'command' key; got: {cmd!r}"
                )
            if cmd.get("command") == "setauth":
                raise ValidationError(
                    f"commands[{i}] must not include 'setauth' — "
                    "it is injected automatically"
                )

        if not auth_token or not isinstance(auth_token, str):
            raise ValidationError("auth_token must be a non-empty string")

        # Build payload — _make_api_request injects setauth automatically
        payload = list(commands)

        # Use the raw request path to avoid _handle_response raising on
        # per-item errors (which are expected in batch results).
        url = urljoin(self.base_url, "api/")
        headers = {"X-Auth": auth_token, "Content-Type": "application/json"}

        # Inject setauth at index 0
        payload.insert(0, {"command": "setauth", "data": auth_token})
        request_data = json.dumps(payload)

        self.logger.debug("Executing batch request with %d commands", len(commands))

        try:
            response = self.session.request(
                method="POST",
                url=url,
                data=request_data,
                headers=headers,
                timeout=self.timeout,
            )
        except requests.exceptions.Timeout as e:
            raise SiloError(f"Request timeout after {self.timeout}s") from e
        except requests.exceptions.ConnectionError as e:
            raise SiloError(f"Connection error: {e}") from e
        except requests.exceptions.RequestException as e:
            raise SiloError(f"Request failed: {e}") from e

        # Handle HTTP-level errors (not per-item API errors)
        request_id = response.headers.get("X-Request-ID")

        if response.status_code == 429:
            retry_after = _parse_retry_after(response.headers.get("Retry-After"))
            raise RateLimitError(
                "Rate limit exceeded",
                status_code=response.status_code,
                request_id=request_id,
                retry_after=retry_after,
            )

        if response.status_code == 401:
            raise _auth_error(response, request_id)

        if not response.ok:
            try:
                error_data = response.json()
            except (ValueError, json.JSONDecodeError):
                error_data = {"error": response.text}

            raise SiloError(
                f"API request failed: {response.status_code} {response.reason}",
                status_code=response.status_code,
                response_data=error_data,
                request_id=request_id,
            )

        # Parse response
        try:
            raw_data: Any = response.json()
        except (ValueError, json.JSONDecodeError) as e:
            raise SiloError(f"Invalid JSON response: {e}") from e

        if not isinstance(raw_data, list):
            raw_data = [raw_data]

        results: list[dict[str, Any]] = raw_data

        # Strip the setauth ack (index 0) unconditionally. A response
        # containing only one element is just the ack itself — e.g. a
        # command rejected at the auth phase, or a result dropped under
        # load — and must never be mistaken for a per-command result.
        # Callers (batch_suspend_users, batch_delete_users) already treat a
        # missing entry as "no response received". See GH issue #43.
        return results[1:]

    @api_tag(MethodType.UTILITY)
    @staticmethod
    def create_ssl_context() -> ssl.SSLContext:
        """Create an SSL context backed by the certifi certificate bundle.

        Returns a context with full certificate validation enabled, using the
        curated CA bundle shipped by the ``certifi`` package rather than the
        host's trust store. The SDK's own async methods use this, and it is
        exposed so that code building its own ``httpx`` client against the
        Silo API verifies certificates the same way.

        The SDK's asynchronous methods are built on ``httpx``; pass the
        context as ``verify=`` when constructing the client. Never substitute
        ``verify=False`` — that disables certificate validation entirely and
        exposes the API token carried in every request payload.

        Build it once and reuse it. Each call reads and parses the certifi CA
        bundle from disk, which is comparatively expensive, so calling this
        per request adds file I/O and certificate parsing to every call. The
        SDK's own async clients build the context once in ``__init__`` and
        hold on to it for the lifetime of the instance; do the same in your
        own code, and keep it out of request paths and loops.

        The returned context is not modified by the SDK. Callers that need a
        private or corporate CA can load additional certificates onto it with
        the standard ``ssl.SSLContext`` methods before use.

        Returns:
            An ``ssl.SSLContext`` configured for certificate validation.

        Examples:
            Build the context once, then reuse it for every request made
            through the client:

            >>> import httpx
            >>> from silo_sdk import BaseAPIClient
            >>> ssl_context = BaseAPIClient.create_ssl_context()
            >>> async with httpx.AsyncClient(verify=ssl_context) as client:
            ...     response = await client.get(url)

            Holding it on an instance, the way the SDK's own async clients
            do, keeps the bundle parse out of the request path:

            >>> class MyAsyncClient:
            ...     def __init__(self) -> None:
            ...         self._ssl_context = BaseAPIClient.create_ssl_context()
            ...
            ...     async def fetch(self, url: str) -> httpx.Response:
            ...         async with httpx.AsyncClient(
            ...             verify=self._ssl_context
            ...         ) as client:
            ...             return await client.get(url)
        """
        return ssl.create_default_context(cafile=certifi.where())

    @staticmethod
    def _validate_params(params: dict[str, Any], valid_params: set[str]) -> None:
        """Validate parameters against allowed set.

        Args:
            params: Parameters to validate
            valid_params: Set of valid parameter names

        Raises:
            ValidationError: If invalid parameters are found
        """
        invalid_params = set(params.keys()) - valid_params
        if invalid_params:
            raise ValidationError(
                f"Invalid parameters: {', '.join(invalid_params)}. "
                f"Valid parameters: {', '.join(sorted(valid_params))}"
            )

    @api_tag(MethodType.UTILITY)
    def close(self) -> None:
        """Close the underlying HTTP session and release its connections.

        Call this when you are finished with a client that was not created as
        a context manager. It is safe to call more than once, and safe to call
        on a client whose session was never opened.

        Prefer the context manager form, which closes the session for you even
        when the block raises.

        Examples:
            >>> api = UserManagementAPI(config)
            >>> try:
            ...     users = api.list_users(org="MyOrg")
            ... finally:
            ...     api.close()

            Equivalent, and preferred:

            >>> with UserManagementAPI(config) as api:
            ...     users = api.list_users(org="MyOrg")
        """
        if hasattr(self, "session"):
            self.session.close()
            self.logger.debug("Closed HTTP session")

    def __enter__(self) -> BaseAPIClient:
        """Enter the context manager and return the client itself.

        Returns:
            This client, so it can be bound with ``as`` in a ``with``
                statement.
        """
        return self

    def _extract_api_result(
        self,
        response: list[dict[str, Any]],
        index: int = 1,
        request_id: str | None = None,
    ) -> Any:
        """Extract the result from the API response.

        Args:
            response: The API response list
            index: Index of the result item in the response (default: 1)
            request_id: Optional request ID from the HTTP response headers,
                forwarded to ``SiloError`` for server-side log correlation.

        Returns:
            The extracted result data

        Raises:
            SiloError: If the result cannot be extracted, or if the response
                reports an error in either of the two shapes the API uses.

        Note:
            The API signals failure in two different places, and both are
            treated as errors here:

            * ``{"error": ...}`` in place of ``result`` — the common shape.
            * ``{"result": {"error": ...}}`` — an error nested *inside* an
              otherwise successful-looking result. ``get_context`` for a
              deleted context ID returns this, for example. Returning it as a
              result would hand the caller a failure dressed as data.

            The command-array endpoint does not use HTTP status codes; a
            rejected command still returns ``HTTP 200``. These two shapes are
            the only failure signal, so neither may be passed through.
        """
        if isinstance(response, list) and len(response) > index:
            result_item = response[index]
            if isinstance(result_item, dict):
                if "result" in result_item:
                    result = result_item["result"]
                    if isinstance(result, dict) and result.get("error"):
                        raise SiloError(
                            f"API error: {_api_error_text(result['error'])}",
                            response_data=result_item,
                            request_id=request_id,
                        )
                    return result
                if "error" in result_item:
                    raise SiloError(
                        f"API error: {_api_error_text(result_item['error'])}",
                        response_data=result_item,
                        request_id=request_id,
                    )

        rendered = self._format_response_for_log(response)
        self.logger.warning("Unexpected response format: %s", rendered)
        raise SiloError(f"Unexpected response format: {rendered}")

    #: Substrings that mark a response key as carrying a credential. Matched
    #: case-insensitively against the key name.
    #:
    #: Derived from :data:`_SENSITIVE_KEY_PARTS` rather than restated, because
    #: the two lists had drifted: the request side masked any key containing
    #: ``key``, the response side only ``api_key``/``apikey``/``private_key``,
    #: so a key such as ``ipsec_key`` was masked on the way out and rendered
    #: in full on the way back. Anything worth hiding in a request is
    #: worth hiding in a response, so the request list is the floor and this
    #: adds only the spellings that appear solely in responses. The broad
    #: substrings over-mask some harmless keys (``last_authorized_ts``); that
    #: is accepted, since this only shapes log lines and error messages.
    _SENSITIVE_KEY_MARKERS: ClassVar[tuple[str, ...]] = _SENSITIVE_KEY_PARTS + (
        "passwd",
        "session_id",
    )

    #: Cap on the rendered length of a response echoed into a log line or an
    #: exception message. Long enough to diagnose a shape mismatch, short
    #: enough that an unexpected body is not dumped wholesale into a log.
    _MAX_RENDERED_RESPONSE_CHARS: ClassVar[int] = 500

    @classmethod
    def _redact_response(cls, response: Any, _depth: int = 0) -> Any:
        """Replace credential-bearing values in an API response.

        Recursive, because the values worth hiding are nested: a
        ``listusers`` result is a list of user dicts, and the tokens or
        session identifiers on those dicts sit two levels below the
        response root. The previous version only walked the top-level list
        and dropped elements whose ``command`` was ``setauth`` -- but
        ``command`` is a *request* key, so it matched nothing and the
        function was a no-op that left a redaction guarantee unmet.

        Args:
            response: Any JSON-decoded fragment of an API response.
            _depth: Recursion guard. Callers should not pass this.

        Returns:
            The same structure with sensitive values replaced by
            ``"<redacted>"``.
        """
        if _depth > 8:
            return "<max depth>"
        if isinstance(response, dict):
            return {
                key: (
                    "<redacted>"
                    if isinstance(key, str)
                    and any(m in key.lower() for m in cls._SENSITIVE_KEY_MARKERS)
                    else cls._redact_response(value, _depth + 1)
                )
                for key, value in response.items()
            }
        if isinstance(response, list):
            return [cls._redact_response(item, _depth + 1) for item in response]
        return response

    @classmethod
    def _format_response_for_log(cls, response: Any) -> str:
        """Render a response for a log line or error message.

        Redacts first, then bounds the length -- the docstring on the old
        redaction helper promised truncation it never performed, so an
        unexpected body went into both a warning log and an exception
        message at full length.
        """
        text = str(cls._redact_response(response))
        if len(text) > cls._MAX_RENDERED_RESPONSE_CHARS:
            text = (
                text[: cls._MAX_RENDERED_RESPONSE_CHARS]
                + f"... [truncated, {len(text)} chars total]"
            )
        return text

    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
        """Exit the context manager, closing the HTTP session.

        The session is closed whether the block completed normally or raised.
        Exceptions are not suppressed — any exception raised inside the
        ``with`` block propagates to the caller.

        Args:
            exc_type: Exception class raised in the block, or None.
            exc_val: Exception instance raised in the block, or None.
            exc_tb: Traceback for the exception, or None.
        """
        self.close()

__init__

__init__(config: dict[str, Any]) -> None

Initialize the base API client.

Reads the following keys from config; every one of them is optional and falls back to the default shown:

Key Default Purpose
API_URL https://extapi.authentic8.com Base URL for all requests
REQUEST_TIMEOUT 30 Per-request timeout in seconds
MAX_RETRIES 3 Retry attempts for idempotent methods
RETRY_DELAY 5 Stored on the client; not read by the SDK
LOG_LEVEL INFO Level for the shared silo_sdk logger
USER_AGENT SDK default User-Agent header sent on every request
PROXY unset Proxy mapping passed through to requests
ENABLE_REQUEST_LOGGING False Log each request's commands, redacted

Subclasses add their own required keys — most importantly the API token for the surface they talk to. See the Configuration guide for the full list and the matching A8_* environment variables.

API_URL must use https. Every request carries an API token in its payload, so a plaintext URL would disclose that token; plain http is accepted only against loopback for local testing, and a URL with embedded user:password@ credentials is always rejected.

Parameters:

Name Type Description Default
config dict[str, Any]

Configuration dictionary containing API settings.

required

Raises:

Type Description
ConfigurationError

If config is not a dictionary, or API_URL is not a string, embeds credentials, or uses a scheme other than https (or http against loopback).

Source code in silo_sdk/base/api_client.py
def __init__(self, config: dict[str, Any]) -> None:
    """Initialize the base API client.

    Reads the following keys from ``config``; every one of them is
    optional and falls back to the default shown:

    | Key | Default | Purpose |
    |---|---|---|
    | ``API_URL`` | ``https://extapi.authentic8.com`` | Base URL for all requests |
    | ``REQUEST_TIMEOUT`` | ``30`` | Per-request timeout in seconds |
    | ``MAX_RETRIES`` | ``3`` | Retry attempts for idempotent methods |
    | ``RETRY_DELAY`` | ``5`` | Stored on the client; not read by the SDK |
    | ``LOG_LEVEL`` | ``INFO`` | Level for the shared ``silo_sdk`` logger |
    | ``USER_AGENT`` | SDK default | ``User-Agent`` header sent on every request |
    | ``PROXY`` | unset | Proxy mapping passed through to ``requests`` |
    | ``ENABLE_REQUEST_LOGGING`` | ``False`` | Log each request's commands, redacted |

    Subclasses add their own required keys — most importantly the API
    token for the surface they talk to. See the Configuration guide for
    the full list and the matching ``A8_*`` environment variables.

    ``API_URL`` must use ``https``. Every request carries an API token in
    its payload, so a plaintext URL would disclose that token; plain
    ``http`` is accepted only against loopback for local testing, and a
    URL with embedded ``user:password@`` credentials is always rejected.

    Args:
        config: Configuration dictionary containing API settings.

    Raises:
        ConfigurationError: If ``config`` is not a dictionary, or
            ``API_URL`` is not a string, embeds credentials, or uses a
            scheme other than ``https`` (or ``http`` against loopback).
    """
    self.config = config

    # Setup logging first so it can be used in validation
    log_level = (
        config.get("LOG_LEVEL", "INFO") if isinstance(config, dict) else "INFO"
    )
    self.logger = self._setup_logger(log_level)

    self._validate_config()

    self.base_url = config.get("API_URL", "https://extapi.authentic8.com")
    self.timeout = config.get("REQUEST_TIMEOUT", 30)
    self.max_retries = config.get("MAX_RETRIES", 3)
    self.retry_delay = config.get("RETRY_DELAY", 5)
    self.enable_request_logging = _config_flag(
        config.get("ENABLE_REQUEST_LOGGING", False)
    )

    # Setup HTTP session
    self.session = self._setup_session()

    self.logger.info("Initialized %s", self.__class__.__name__)

batch_request

batch_request(commands: list[dict[str, Any]], auth_token: str) -> list[dict[str, Any]]

Execute multiple wire-format commands in a single batch POST.

Sends every command to the Authentic8 API in a single HTTP round trip instead of one request per command. The setauth command is injected automatically — do not include it.

Unlike the single-command methods on the API subclasses, per-item errors in the response are not raised as exceptions. Each result dict may contain either a "result" key (success) or an "error" key (failure for that one command), and the caller is responsible for inspecting individual results. Only failures of the HTTP request as a whole raise.

The response is positional: results come back in the order the commands were submitted. A short list means the server did not return a result for every command — treat a missing entry as "no response received" rather than as success.

Parameters:

Name Type Description Default
commands list[dict[str, Any]]

Non-empty list of command dicts. Each must have a "command" key with params flat alongside it. Do not include setauth.

required
auth_token str

Authentication token to use for the batch.

required

Returns:

Type Description
list[dict[str, Any]]

List of result dicts, one per submitted command (the setauth acknowledgment at index 0 is stripped).

Raises:

Type Description
ValidationError

If commands is empty, any command is missing the "command" key, or any command is setauth.

SiloError

If the HTTP request itself fails (timeout, connection error, non-200 status code).

Examples:

>>> client = BaseAPIClient(config)
>>> results = client.batch_request(
...     [
...         {"command": "listusers", "org": "MyOrg"},
...         {"command": "deleteuser", "username": "u@co.com"},
...     ],
...     auth_token=config["SYNC_TOKEN"],
... )
>>> for r in results:
...     print(r.get("result") or r.get("error"))
Source code in silo_sdk/base/api_client.py
@api_tag(MethodType.UTILITY)
def batch_request(
    self,
    commands: list[dict[str, Any]],
    auth_token: str,
) -> list[dict[str, Any]]:
    """Execute multiple wire-format commands in a single batch POST.

    Sends every command to the Authentic8 API in a single HTTP round trip
    instead of one request per command. The ``setauth`` command is
    injected automatically — do not include it.

    Unlike the single-command methods on the API subclasses, per-item
    errors in the response are **not** raised as exceptions. Each result
    dict may contain either a ``"result"`` key (success) or an
    ``"error"`` key (failure for that one command), and the caller is
    responsible for inspecting individual results. Only failures of the
    HTTP request as a whole raise.

    The response is positional: results come back in the order the
    commands were submitted. A short list means the server did not return
    a result for every command — treat a missing entry as "no response
    received" rather than as success.

    Args:
        commands: Non-empty list of command dicts. Each must have a
            ``"command"`` key with params flat alongside it. Do not
            include ``setauth``.
        auth_token: Authentication token to use for the batch.

    Returns:
        List of result dicts, one per submitted command (the ``setauth``
            acknowledgment at index 0 is stripped).

    Raises:
        ValidationError: If ``commands`` is empty, any command is missing
            the ``"command"`` key, or any command is ``setauth``.
        SiloError: If the HTTP request itself fails (timeout, connection
            error, non-200 status code).

    Examples:
        >>> client = BaseAPIClient(config)
        >>> results = client.batch_request(
        ...     [
        ...         {"command": "listusers", "org": "MyOrg"},
        ...         {"command": "deleteuser", "username": "u@co.com"},
        ...     ],
        ...     auth_token=config["SYNC_TOKEN"],
        ... )
        >>> for r in results:
        ...     print(r.get("result") or r.get("error"))
    """
    if not commands:
        raise ValidationError("commands must be a non-empty list")

    for i, cmd in enumerate(commands):
        if not isinstance(cmd, dict) or "command" not in cmd:
            raise ValidationError(
                f"commands[{i}] must be a dict with a 'command' key; got: {cmd!r}"
            )
        if cmd.get("command") == "setauth":
            raise ValidationError(
                f"commands[{i}] must not include 'setauth' — "
                "it is injected automatically"
            )

    if not auth_token or not isinstance(auth_token, str):
        raise ValidationError("auth_token must be a non-empty string")

    # Build payload — _make_api_request injects setauth automatically
    payload = list(commands)

    # Use the raw request path to avoid _handle_response raising on
    # per-item errors (which are expected in batch results).
    url = urljoin(self.base_url, "api/")
    headers = {"X-Auth": auth_token, "Content-Type": "application/json"}

    # Inject setauth at index 0
    payload.insert(0, {"command": "setauth", "data": auth_token})
    request_data = json.dumps(payload)

    self.logger.debug("Executing batch request with %d commands", len(commands))

    try:
        response = self.session.request(
            method="POST",
            url=url,
            data=request_data,
            headers=headers,
            timeout=self.timeout,
        )
    except requests.exceptions.Timeout as e:
        raise SiloError(f"Request timeout after {self.timeout}s") from e
    except requests.exceptions.ConnectionError as e:
        raise SiloError(f"Connection error: {e}") from e
    except requests.exceptions.RequestException as e:
        raise SiloError(f"Request failed: {e}") from e

    # Handle HTTP-level errors (not per-item API errors)
    request_id = response.headers.get("X-Request-ID")

    if response.status_code == 429:
        retry_after = _parse_retry_after(response.headers.get("Retry-After"))
        raise RateLimitError(
            "Rate limit exceeded",
            status_code=response.status_code,
            request_id=request_id,
            retry_after=retry_after,
        )

    if response.status_code == 401:
        raise _auth_error(response, request_id)

    if not response.ok:
        try:
            error_data = response.json()
        except (ValueError, json.JSONDecodeError):
            error_data = {"error": response.text}

        raise SiloError(
            f"API request failed: {response.status_code} {response.reason}",
            status_code=response.status_code,
            response_data=error_data,
            request_id=request_id,
        )

    # Parse response
    try:
        raw_data: Any = response.json()
    except (ValueError, json.JSONDecodeError) as e:
        raise SiloError(f"Invalid JSON response: {e}") from e

    if not isinstance(raw_data, list):
        raw_data = [raw_data]

    results: list[dict[str, Any]] = raw_data

    # Strip the setauth ack (index 0) unconditionally. A response
    # containing only one element is just the ack itself — e.g. a
    # command rejected at the auth phase, or a result dropped under
    # load — and must never be mistaken for a per-command result.
    # Callers (batch_suspend_users, batch_delete_users) already treat a
    # missing entry as "no response received". See GH issue #43.
    return results[1:]

create_ssl_context staticmethod

create_ssl_context() -> ssl.SSLContext

Create an SSL context backed by the certifi certificate bundle.

Returns a context with full certificate validation enabled, using the curated CA bundle shipped by the certifi package rather than the host's trust store. The SDK's own async methods use this, and it is exposed so that code building its own httpx client against the Silo API verifies certificates the same way.

The SDK's asynchronous methods are built on httpx; pass the context as verify= when constructing the client. Never substitute verify=False — that disables certificate validation entirely and exposes the API token carried in every request payload.

Build it once and reuse it. Each call reads and parses the certifi CA bundle from disk, which is comparatively expensive, so calling this per request adds file I/O and certificate parsing to every call. The SDK's own async clients build the context once in __init__ and hold on to it for the lifetime of the instance; do the same in your own code, and keep it out of request paths and loops.

The returned context is not modified by the SDK. Callers that need a private or corporate CA can load additional certificates onto it with the standard ssl.SSLContext methods before use.

Returns:

Type Description
SSLContext

An ssl.SSLContext configured for certificate validation.

Examples:

Build the context once, then reuse it for every request made through the client:

>>> import httpx
>>> from silo_sdk import BaseAPIClient
>>> ssl_context = BaseAPIClient.create_ssl_context()
>>> async with httpx.AsyncClient(verify=ssl_context) as client:
...     response = await client.get(url)

Holding it on an instance, the way the SDK's own async clients do, keeps the bundle parse out of the request path:

>>> class MyAsyncClient:
...     def __init__(self) -> None:
...         self._ssl_context = BaseAPIClient.create_ssl_context()
...
...     async def fetch(self, url: str) -> httpx.Response:
...         async with httpx.AsyncClient(
...             verify=self._ssl_context
...         ) as client:
...             return await client.get(url)
Source code in silo_sdk/base/api_client.py
@api_tag(MethodType.UTILITY)
@staticmethod
def create_ssl_context() -> ssl.SSLContext:
    """Create an SSL context backed by the certifi certificate bundle.

    Returns a context with full certificate validation enabled, using the
    curated CA bundle shipped by the ``certifi`` package rather than the
    host's trust store. The SDK's own async methods use this, and it is
    exposed so that code building its own ``httpx`` client against the
    Silo API verifies certificates the same way.

    The SDK's asynchronous methods are built on ``httpx``; pass the
    context as ``verify=`` when constructing the client. Never substitute
    ``verify=False`` — that disables certificate validation entirely and
    exposes the API token carried in every request payload.

    Build it once and reuse it. Each call reads and parses the certifi CA
    bundle from disk, which is comparatively expensive, so calling this
    per request adds file I/O and certificate parsing to every call. The
    SDK's own async clients build the context once in ``__init__`` and
    hold on to it for the lifetime of the instance; do the same in your
    own code, and keep it out of request paths and loops.

    The returned context is not modified by the SDK. Callers that need a
    private or corporate CA can load additional certificates onto it with
    the standard ``ssl.SSLContext`` methods before use.

    Returns:
        An ``ssl.SSLContext`` configured for certificate validation.

    Examples:
        Build the context once, then reuse it for every request made
        through the client:

        >>> import httpx
        >>> from silo_sdk import BaseAPIClient
        >>> ssl_context = BaseAPIClient.create_ssl_context()
        >>> async with httpx.AsyncClient(verify=ssl_context) as client:
        ...     response = await client.get(url)

        Holding it on an instance, the way the SDK's own async clients
        do, keeps the bundle parse out of the request path:

        >>> class MyAsyncClient:
        ...     def __init__(self) -> None:
        ...         self._ssl_context = BaseAPIClient.create_ssl_context()
        ...
        ...     async def fetch(self, url: str) -> httpx.Response:
        ...         async with httpx.AsyncClient(
        ...             verify=self._ssl_context
        ...         ) as client:
        ...             return await client.get(url)
    """
    return ssl.create_default_context(cafile=certifi.where())

close

close() -> None

Close the underlying HTTP session and release its connections.

Call this when you are finished with a client that was not created as a context manager. It is safe to call more than once, and safe to call on a client whose session was never opened.

Prefer the context manager form, which closes the session for you even when the block raises.

Examples:

>>> api = UserManagementAPI(config)
>>> try:
...     users = api.list_users(org="MyOrg")
... finally:
...     api.close()

Equivalent, and preferred:

>>> with UserManagementAPI(config) as api:
...     users = api.list_users(org="MyOrg")
Source code in silo_sdk/base/api_client.py
@api_tag(MethodType.UTILITY)
def close(self) -> None:
    """Close the underlying HTTP session and release its connections.

    Call this when you are finished with a client that was not created as
    a context manager. It is safe to call more than once, and safe to call
    on a client whose session was never opened.

    Prefer the context manager form, which closes the session for you even
    when the block raises.

    Examples:
        >>> api = UserManagementAPI(config)
        >>> try:
        ...     users = api.list_users(org="MyOrg")
        ... finally:
        ...     api.close()

        Equivalent, and preferred:

        >>> with UserManagementAPI(config) as api:
        ...     users = api.list_users(org="MyOrg")
    """
    if hasattr(self, "session"):
        self.session.close()
        self.logger.debug("Closed HTTP session")

__enter__

__enter__() -> BaseAPIClient

Enter the context manager and return the client itself.

Returns:

Type Description
BaseAPIClient

This client, so it can be bound with as in a with statement.

Source code in silo_sdk/base/api_client.py
def __enter__(self) -> BaseAPIClient:
    """Enter the context manager and return the client itself.

    Returns:
        This client, so it can be bound with ``as`` in a ``with``
            statement.
    """
    return self

__exit__

__exit__(exc_type: Any, exc_val: Any, exc_tb: Any) -> None

Exit the context manager, closing the HTTP session.

The session is closed whether the block completed normally or raised. Exceptions are not suppressed — any exception raised inside the with block propagates to the caller.

Parameters:

Name Type Description Default
exc_type Any

Exception class raised in the block, or None.

required
exc_val Any

Exception instance raised in the block, or None.

required
exc_tb Any

Traceback for the exception, or None.

required
Source code in silo_sdk/base/api_client.py
def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
    """Exit the context manager, closing the HTTP session.

    The session is closed whether the block completed normally or raised.
    Exceptions are not suppressed — any exception raised inside the
    ``with`` block propagates to the caller.

    Args:
        exc_type: Exception class raised in the block, or None.
        exc_val: Exception instance raised in the block, or None.
        exc_tb: Traceback for the exception, or None.
    """
    self.close()