Skip to main content

Authese

Authenticate through OpenID Connect and cache your JWT token in a file.

Example

from authese import get_token, EnvConfig, Environment

token = get_token(EnvConfig.from_env(Environment.STAGING))

Install

pip install authese

Info

There are 3 possible environments.

  • LOCAL
  • STAGING
  • PROD

Assuming STAGING

Create an EnvConfig object. Call get_token() and provide it with the EnvConfig object.

EnvConfig

- Personal access token

grant_type: '' Identical to grant_type: 'authorization_code'
This is the default authorization flow.
This will open a browser window where you can authenticate to the requested keycloak_url.

- Server to server

Depending if you set the grant_type: 'client_credentials'.
This will authenticate to the requested keycloak_url using the client credentials.

Cache

Once authenticated, your token will be cached at /tmp/authese-cache.dat
Subsequent calls to get_token() will use the cached token.
When the token expires it will be deleted and you must authenticate again.

To force reauthentication just remove the /tmp/authese-cache.dat file.

Config

local:
staging:
  keycloak_url: 'https://<openid-host>/realms/<realm>/protocol/openid-connect'
  grant_type: '<authorization_code | client_credentials>'
  client_id: '<client_id>'
  client_secret: '<client_secret>'
  redirect_host: 'http://127.0.0.1'
  redirect_port: 9981
  scopes:
    - 'email'
    - 'profile'
prod:
  keycloak_url: 'https://<openid-host>/realms/<realm>/protocol/openid-connect'
  grant_type: '<authorization_code | client_credentials>'
  client_id: '<client_id>'
  client_secret: '<client_secret>'
  redirect_host: 'http://127.0.0.1'
  redirect_port: 9981
  scopes:
    - 'email'
    - 'profile'

Metadata

Release files for authese 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for authese 0.1.7
File Size Uploaded Provenance
authese-0.1.7.tar.gz 5.6 kB With provenance Details

Release files / authese-0.1.7.tar.gz

Download URL authese-0.1.7.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
191b96ea51bf882011a3f398ddb3ea9db4645c83147859c8089405c39cb8b5c7
BLAKE2b-256 checksum
How to use checksums
8a9c32e08912f603f71a6c6fddca69bbab62749564fde7b5cffd511642a8ed40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 6, 2025.

Transparency log

Security for authese 0.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 1 file in this release has been uploaded with provenance metadata.

Attestation for authese-0.1.7.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 6, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page