Skip to main content

Add your description here

Project description

oidc-auth-client

Build and Publish

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.

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.4.tar.gz (13.2 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.4-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oidc_auth_client-0.1.4.tar.gz
  • Upload date:
  • Size: 13.2 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.4.tar.gz
Algorithm Hash digest
SHA256 03433b25b1894fbcde68dd48766ed5a94c1aee40fc1b4dfafaab13b5cc1481e2
MD5 81c2e641494e01bf6f631c9bcb30747f
BLAKE2b-256 47e87737662d291a986e5a573597270b860cb994cbeaef9359c519eebb884d5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oidc_auth_client-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c3da298e4ee44584294c24e7cdce5412680006708e9c650c1ade8c8136f87ef9
MD5 c5a377c3b8bbbf98dbc4854be5504314
BLAKE2b-256 344bbebc1ed2a8d1e53ebd4aa6d44c8501d74d4e6808bc69989116291a58f99e

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