Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JWT documentation to recommend only using jwt_header or audit logging not both #5914

Merged
merged 72 commits into from
Dec 21, 2023
Merged
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
badb6ca
readd auth token doc
stephen-crawford Nov 7, 2023
a95956f
Merge branch 'opensearch-project:main' into main
stephen-crawford Nov 8, 2023
29c6b4e
Merge branch 'main' into main
stephen-crawford Nov 10, 2023
4921bcc
Merge branch 'opensearch-project:main' into main
stephen-crawford Nov 13, 2023
10158d3
Fix vale
stephen-crawford Nov 13, 2023
031054c
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
57858d5
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
7aabc93
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
231b571
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
f2c257b
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
89f2ea6
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
b65267e
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
8be7a23
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
3702667
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
b07d204
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
f196b48
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
b97006f
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
05c2cf4
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
66ff464
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
813bcb5
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
6b5c8e3
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
5510088
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
f542553
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
ef0f543
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
c0ef181
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
035cae6
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
e51cff1
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
de00af4
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
69663c9
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
7e78e8e
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
c7d6c79
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
e178fa2
Apply suggestions from code review
stephen-crawford Nov 14, 2023
e3c764d
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
db16f8a
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
1f18c74
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
c0f22a5
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
21beb15
Apply suggestions from code review
stephen-crawford Nov 14, 2023
663ac2c
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 14, 2023
ffe5bfa
Fix embedded command
stephen-crawford Nov 14, 2023
b96a080
Merge branch 'main' into main
stephen-crawford Nov 14, 2023
b6f1bd8
Blank lines after headings
stephen-crawford Nov 14, 2023
5b15faa
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
ee7a698
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
f720020
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
8575296
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
7a104c3
change
stephen-crawford Nov 16, 2023
811922a
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
fe674d4
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
705bd90
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
d7210f1
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
3e3cd24
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
027718d
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
97d6d58
Apply suggestions from code review
stephen-crawford Nov 16, 2023
580b4d9
Style guidelines
stephen-crawford Nov 16, 2023
46a15ff
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 16, 2023
2e0ccd5
Merge branch 'main' into main
stephen-crawford Nov 16, 2023
f62c004
Apply suggestions from code review
stephen-crawford Nov 16, 2023
8be2f8a
Merge branch 'opensearch-project:main' into main
stephen-crawford Nov 17, 2023
314bd7b
Merge branch 'main' into main
stephen-crawford Nov 20, 2023
9b42310
Merge branch 'main' into main
stephen-crawford Nov 20, 2023
03d2186
Merge branch 'main' into main
stephen-crawford Nov 20, 2023
edd48d1
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 28, 2023
c3e2c5b
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 28, 2023
0476791
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 28, 2023
26d20eb
Update _security/access-control/authentication-tokens.md
stephen-crawford Nov 28, 2023
4da1911
Merge branch 'main' into main
stephen-crawford Nov 28, 2023
0385cdf
Merge branch 'opensearch-project:main' into main
stephen-crawford Dec 19, 2023
11e7b79
warn about audit logging of custom headers
stephen-crawford Dec 19, 2023
b4cbec0
Merge branch 'main' into updateJWTDoc
stephen-crawford Dec 20, 2023
36359fe
Merge branch 'main' into updateJWTDoc
stephen-crawford Dec 20, 2023
341a8c6
Update _security/authentication-backends/jwt.md
stephen-crawford Dec 21, 2023
5ef6209
Merge branch 'main' into updateJWTDoc
stephen-crawford Dec 21, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _security/authentication-backends/jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ The following table lists the configuration parameters.
Name | Description
:--- | :---
`signing_key` | The signing key to use when verifying the token. If you use a symmetric key algorithm, it is the base64-encoded shared secret. If you use an asymmetric algorithm, it contains the public key.
`jwt_header` | The HTTP header in which the token is transmitted. This is typically the `Authorization` header with the `Bearer` schema: `Authorization: Bearer <token>`. Default is `Authorization`.
`jwt_header` | The HTTP header in which the token is transmitted. This is typically the `Authorization` header with the `Bearer` schema,`Authorization: Bearer <token>`. Default is `Authorization`. Replacing this field with a value other than `Authorization` prevents the audit log from properly redacting the JWT header from audit messages. It is recommended that users only use `Authorization` when using JWTs with audit logging.
`jwt_url_parameter` | If the token is not transmitted in the HTTP header but rather as an URL parameter, define the name of the parameter here.
`subject_key` | The key in the JSON payload that stores the username. If not set, the [subject](https://tools.ietf.org/html/rfc7519#section-4.1.2) registered claim is used.
`roles_key` | The key in the JSON payload that stores the user's roles. The value of this key must be a comma-separated list of roles.
Expand Down
Loading