Skip to main content

IAM V2 client library for EaseCation services (Python port of @easecation/iam-client)

Project description

easecation-iam-client

Python port of @easecation/iam-client. IAM V2 API wrapper for EaseCation services.

Install

pip install easecation-iam-client

Or from repo:

pip install -e packages/iam-client-py

Usage

from easecation_iam_client import IamClient, create_iam_client_from_env

# From env (IAM_BASE_URL, IAM_CLIENT_ID, IAM_CLIENT_SECRET)
client = create_iam_client_from_env()

# Or explicit config
client = IamClient(
    iam_base_url="https://iamapi.easecation.net",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)

# OAuth code exchange
tokens = client.exchange_oauth_code(code, redirect_uri)

# Verify access token
verify = client.verify_token(access_token)

# API key verification
api_key_data = client.verify_api_key(key_value)

# App session verification
valid = client.verify_app_session_token(app_session_token)

# Cross-app callback with IAM-managed API key refresh/retry.
player = client.with_app_api_key(
    lambda api_key: ecapi.player.get_info(
        {"displayName": "Steve"},
        auth={"type": "apiKey", "apiKey": api_key},
    ),
    name="service -> ECAPI",
)

API

  • get_app_session_token(), invalidate_app_token()
  • exchange_oauth_code(code, redirect_uri)
  • verify_token(access_token), evict_from_verify_cache(access_token)
  • refresh_token(refresh_token), revoke_token(refresh_token)
  • get_jwks(), get_user_profile(access_token), get_user_bootstrap(...), get_hr_bootstrap_data(...)
  • verify_iam_callback_token(iam_token, ...), get_user_permissions(user_id, ...)
  • verify_api_key(key_value), evict_api_key_from_cache(key_value), clear_api_key_cache()
  • verify_app_session_token(app_session_token), clear_app_session_verify_cache()
  • get_app_api_key(...), with_app_api_key(callback, ...)

ApiKeyRotationHelper for zero-downtime key rotation: create_new_key(...), revoke_key(key_id, ...), list_active_keys(owner_id?).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easecation_iam_client-1.4.0.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easecation_iam_client-1.4.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file easecation_iam_client-1.4.0.tar.gz.

File metadata

  • Download URL: easecation_iam_client-1.4.0.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for easecation_iam_client-1.4.0.tar.gz
Algorithm Hash digest
SHA256 bc904089d863d359275f37d8cf52b353cc195b314b1e5111741b34c0f1124e9c
MD5 a0ebff821d0a55412cb577211321ac0d
BLAKE2b-256 365ac38212077a9996a3daad196486154a98abe10f53a16935b64b0ad570a53d

See more details on using hashes here.

File details

Details for the file easecation_iam_client-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for easecation_iam_client-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79acb84e340c75068bca37c56de572b0aaf7252aad1873a278b104e8bb29a7aa
MD5 e0b81d6d57b38440c42dc199ec555b0e
BLAKE2b-256 6bf2ea2b51007695b79232da1d3a048e7a7447f38108ef37714c568b3deb84cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page