Skip to content

feat: aud documentation #130

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 30, 2025
+11 −0
Merged

feat: aud documentation #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/router/authentication-and-authorization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ In the current router version, the configuration and behavior of authentication
refresh_interval: 2m
# optional list of allowed algorithms per JWKS
algorithms: ["RS256", "EdDSA", "HS512"]
audiences:
- http://aud1
- http://aud2
- symmetric_algorithm: HS256
secret: <your_secret>
header_key_id: some-key-id
Expand Down
8 changes: 8 additions & 0 deletions docs/router/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1427,6 +1427,14 @@ This is useful when you have a symmetric key that you cannot expose through a JW
| symmetric_algorithm | <Icon icon="square-check" iconType="solid" /> | Specify which symmetric algorithm is used for signing, supported algorithms are "HS256", "HS384", "HS512" | |


#### Audience Validation
In addition to the above JWKS configuration flavours, you can define a list of audiences of which one is required (if specified) with either options.

| YAML | Required | Description | Default Value |
| --------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -----------------|
| audiences | <Icon icon="square" /> | The allowed list of audiences, of which at least one audience is required in the token | [] |


### JWT

| YAML | Required | Description | Default Value |
Expand Down