Skip to main content

Demonstration OpenID Connect Client

Project description

Auth Playground

Tests Docker Docker Image

A demonstration OAuth2 / OpenID Connect (OIDC) client application built with Authlib. This project illustrates how to integrate with an identity provider for user authentication, registration, and consent management. It can be used to play with the different interactions between clients and server, or debug a server implementation.

Installation

Using pip

pip install auth-playground

Using uv

uv add auth-playground

Using Docker

Run the pre-built image from GitHub Container Registry:

docker run -p 4000:4000 -e SECRET_KEY="your-secret-key" ghcr.io/authlib/auth-playground:latest

Or build locally:

docker build -t auth-playground .
docker run -p 4000:4000 -e SECRET_KEY="your-secret-key" auth-playground

Configuration

The application is configured using environment variables. Copy the example configuration file:

cp example.env .env

Edit .env and set the required values:

# Required
export SECRET_KEY="your-secret-key"

# Optional
export OAUTH_CLIENT_ID="your-client-id"
export OAUTH_CLIENT_SECRET="your-client-secret"
export OAUTH_AUTH_SERVER="https://your-identity-provider.example.com"

Registering with your Identity Provider

When registering this application with your identity provider, configure the following redirect URIs:

http://localhost:4000/login_callback
http://localhost:4000/logout_callback

Usage

auth-playground

The application will be available at http://localhost:4000

Development

Running Tests

uv run pytest

Code Style

uv run prek run --all-files

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

auth_playground-0.1.2.tar.gz (143.4 kB view details)

Uploaded Source

Built Distribution

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

auth_playground-0.1.2-py3-none-any.whl (64.5 kB view details)

Uploaded Python 3

File details

Details for the file auth_playground-0.1.2.tar.gz.

File metadata

  • Download URL: auth_playground-0.1.2.tar.gz
  • Upload date:
  • Size: 143.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for auth_playground-0.1.2.tar.gz
Algorithm Hash digest
SHA256 91cc66bc29f42182fa6325157f2712038711f597358f9e0e3d07f63dda85666b
MD5 11a0610c19cb43b3ba3addb77388b623
BLAKE2b-256 726c61db2ccbc98510db8b07129710a7772c76cc50a85205c6da42e29f7a4d87

See more details on using hashes here.

Provenance

The following attestation bundles were made for auth_playground-0.1.2.tar.gz:

Publisher: release.yml on authlib/auth-playground

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file auth_playground-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for auth_playground-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d5bc648d95bde5850f37ceea84cc4ea6338457af67ed9a0e3d4c3d1ea6c7cd80
MD5 6631ff6bb7b79379f743d9c4048b2650
BLAKE2b-256 f2804136d30ffae24c98a98df7016afbe4a59e12b80f7ee5edd6cd8794b20435

See more details on using hashes here.

Provenance

The following attestation bundles were made for auth_playground-0.1.2-py3-none-any.whl:

Publisher: release.yml on authlib/auth-playground

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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