Quick Settings

Setup these environment variables to define your OAUTH details

Specify the client secrets file. CLIENT_SECRETS_JSON=client_secrets.json

client secrets file

The example uses Okta dev domains to set up.

Register at OKTA (developer.okta.com) or another OIDC provider and then complete the relevant details in the example client_secrets.json file found in the ./resources/ folder.

Setup of configuration can be by file or by environment variables.

Set the CLIENT_SECRETS_JSON environment variable to the location of your client secrets JSON file.

Example JSON format file for okta.com

{
"auth_uri": "https://{{domain}}.okta.com/oauth2/default/v1/authorize",
"client_id": "{{client_id}}",
"client_secret": "{{client_secret}}",
"redirect_uri": "http://localhost:5052/oidc/oidc_callback",
"issuer": "https://{{domain}}.okta.com/oauth2/default",
"token_uri": "https://{{domain}}.okta.com/oauth2/default/v1/token",
"userinfo_uri": "https://{{domain}}.okta.com/oauth2/default/v1/userinfo",
"scope": "openid email profile groups",
"userinfo_key_groups": "groups"
}

Register at OKTA or your OAUTH / OIDC provider

Replace {domain} with the domain of your Okta registered domain. Insert the client_id and client_secret.

OIDC setup

Most of the file is standard OIDC setup. Set these additional values to configure retrieving scopes and groups for access security.

value description
scope list of scopes to retrieve
userinfo_key_groups the key of userinfo that holds a list of groups for the user. Default groups

Environment variables for OIDC setup

Instead of using a configuration file all settings can be specified using individual environment values. As follows:

setting environment name default value
auth_uri OIDC_AUTH_URI http://localhost:5000/testing/authorize
client_id OIDC_CLIENT_ID testing
client_secret OIDC_CLIENT_SECRET testing
redirect_uri OIDC_REDIRECT_URI http://localhost:5000/oidc/callback
issuer OIDC_ISSUER http://localhost:5000/testing/authorize
token_uri OIDC_TOKEN_URI http://localhost:5000/testing/token
scope OIDC_SCOPE openid email profile
userinfo_key_groups OIDC_USERINFO_KEY_GROUPS groups
userinfo_uri OIDC_USERINFO_URI http://localhost:5000/testing/userinfo

NOTE: if you use a file to configure single sign on, these environment variables are not used.