Skip to content

Commit 9f42596

Browse files
MarlincMarlin Cremers
authored and
Marlin Cremers
committed
docs(bearer_token): add information about auth_scheme and HTTP 406
1 parent 518d814 commit 9f42596

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/oathkeeper/pipeline/authn.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,8 @@ The request isn't authorized because the provided credentials are invalid.
339339

340340
The `bearer_token` authenticator will forward the request method, path and headers to a session store. If the session store
341341
returns `200 OK` and body `{ "subject": "...", "extra": {} }` then the authenticator will set the subject appropriately. Please
342-
note that Gzipped responses from `check_session_url` are not supported, and will fail silently.
342+
note that Gzipped responses from `check_session_url` are not supported, and will fail silently. You can return `HTTP 406`
343+
to skip to the next authentication method.
343344

344345
### `bearer_token` Configuration
345346

@@ -357,6 +358,8 @@ note that Gzipped responses from `check_session_url` are not supported, and will
357358
pointing to the `sub` field. This defaults to `sub`. Example: `identity.id` for `{ "identity": { "id": "1234" } }`.
358359
- `token_from` (object, optional) - The location of the bearer token. If not configured, the token will be received from a default
359360
location - 'Authorization' header. One and only one location (header, query, or cookie) must be specified.
361+
- `auth_scheme` (string, optional, one of) - The auth scheme (case insensitive) that must prefix the token for request
362+
authentication when the header is set to `Authorization`. This defaults to `Bearer` for. It can only be set along with `header``.
360363
- `header` (string, required, one of) - The header (case insensitive) that must contain a Bearer token for request
361364
authentication. It can't be set along with `query_parameter` or `cookie`.
362365
- `query_parameter` (string, required, one of) - The query parameter (case sensitive) that must contain a Bearer token for

0 commit comments

Comments
 (0)