Skip to main content

Pure python implementation of an OIDC client

Project description

oidc-auth-client

Build and Publish

Pure python implementation of an OIDC client

Dependencies:

Installing

pip install oidc-auth-client

Example usage

Authorization Code Flow

Use this flow when your application needs to authenticate a real user.

It will:

  1. Open the user’s browser
  2. Redirect them to your identity provider’s login page
  3. Wait for the user to authenticate
  4. Receive an authorization code
  5. Exchange it for an access token

Best for CLIs, desktop apps, and tools acting on behalf of a user.

from oidc_auth_client import Config, AuthorizationCode, OidcProvider

config = Config(
    client_id="<your-client-id>",
    oidc_provider=OidcProvider(
        openid_configuration_url="<auth-provider-url>/.well-known/openid-configuration"
    )
)

# Sign in with the identity provider in the opened browser!
access_token = AuthorizationCode(config=config).get_token()

Client Credentials Flow

Use this flow when your application needs to authenticate as itself, without user interaction. The client exchanges its own client_id and client_secret directly for an access token.

Ideal for:

  • Backend services
  • Server-to-server APIs
  • Cron jobs
  • Automated tasks
from oidc_auth_client import ClientCredentials, OidcProvider, TokenCache
from oidc_auth_client.client_credentials import ClientCredentialsConfig

config = ClientCredentialsConfig(
    client_id=CLIENT_ID,
    client_secret=CLIENT_SECRET,
    oidc_provider=OidcProvider(openid_configuration_url=OPENID_CONFIGURATION_URL),
)

access_token = ClientCredentials(config=config).get_token()

Token caching between runs

To allow the user to cache the token between usages, configure with a TokenCache. Will store the token in plaintext on the users system.

from oidc_auth_client import Config, TokenCache

config = Config(
    # ...
    token_cache=TokenCache(),
)

see some example usage in the examples folder.

Contributing

Requirements:

  • uv ^0.7.22

Setup:

uv sync

Run tests:

uv run pytest .

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

oidc_auth_client-0.1.8.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

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

oidc_auth_client-0.1.8-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file oidc_auth_client-0.1.8.tar.gz.

File metadata

  • Download URL: oidc_auth_client-0.1.8.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for oidc_auth_client-0.1.8.tar.gz
Algorithm Hash digest
SHA256 0c095aa2552ff28e8d93094900c0ef60bb066d25fbbc4e5119687af2d83a6e73
MD5 d65c52ffe0e697fab7bcae6b8394ee1a
BLAKE2b-256 dcef609c83ede7fce2ff85bbc008215b0769564bcf7e088a1316dbf4395c262e

See more details on using hashes here.

File details

Details for the file oidc_auth_client-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: oidc_auth_client-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for oidc_auth_client-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5e99c3862edbd2b34adcfa324fa1737b19e6fbbdc0dcd0b159e451c141615bd2
MD5 4fe5d52d55ed90841733d1f37467454d
BLAKE2b-256 726343a433636f1ed3d872c6cb384c76eaeeb03c72d4e190988e9fe53da93295

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