Skip to content

Commit d0977d8

Browse files
Document TABPY_LOG_DETAILS dependency and list TABPY_OAUTH_* params in config reference.
1 parent ce86ff2 commit d0977d8

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

docs/server-config.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ at [`logging.config` documentation page](https://docs.python.org/3.6/library/log
7171
makes TabPy require credentials with HTTP(S) requests. More details about
7272
authentication can be found in [Authentication](#authentication)
7373
section. Default value - not set.
74+
- `TABPY_OAUTH_ENABLED`, `TABPY_OAUTH_ISSUER`, `TABPY_OAUTH_JWKS_URI`,
75+
`TABPY_OAUTH_AUDIENCE`, `TABPY_OAUTH_REQUIRED_SCOPES`,
76+
`TABPY_OAUTH_LOG_USER` - configure OAuth/JWT Bearer token authentication.
77+
See [OAuth / JWT Bearer Token Authentication](#oauth--jwt-bearer-token-authentication).
7478
- `TABPY_TRANSFER_PROTOCOL` - transfer protocol. Default value - `http`. If
7579
set to `https` two additional parameters have to be specified:
7680
`TABPY_CERTIFICATE_FILE` and `TABPY_KEY_FILE`.
@@ -316,7 +320,10 @@ TABPY_OAUTH_LOG_USER = true
316320
- `TABPY_OAUTH_LOG_USER` (default `false`) sets the JWT's `sub` claim as the
317321
authenticated user for logging purposes. The `sub` claim is often a
318322
user's email or SSO ID, so leave this disabled unless that's an
319-
acceptable thing to write to logs in your environment.
323+
acceptable thing to write to logs in your environment. This has no
324+
effect unless [`TABPY_LOG_DETAILS`](#request-context-logging) is also
325+
enabled -- that's what actually logs the authenticated user, for both
326+
basic auth and OAuth.
320327

321328
To authenticate a request, send the JWT as a Bearer token:
322329

0 commit comments

Comments
 (0)