Skip to content

Commit 597926c

Browse files
committed
Document more openid settings
The setting descriptions are copied from jwt.md as openid is also jwt-based. required_audience and required_issuer were added in opensearch-project/security@4b38671 Rationale explained in opensearch-project/security#2766 Signed-off-by: Märt Bakhoff <[email protected]>
1 parent 2673a84 commit 597926c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

_security/authentication-backends/openid-connect.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ config:
5151
subject_key: preferred_username
5252
roles_key: roles
5353
openid_connect_url: https://keycloak.example.com:8080/auth/realms/master/.well-known/openid-configuration
54+
required_audience: your-openid-client-id
5455
authentication_backend:
5556
type: noop
5657
```
@@ -64,6 +65,9 @@ Name | Description
6465
`jwt_url_parameter` | If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.
6566
`subject_key` | The key in the JSON payload that stores the user's name. If not defined, the [subject](https://tools.ietf.org/html/rfc7519#section-4.1.2) registered claim is used. Most IdP providers use the `preferred_username` claim. Optional.
6667
`roles_key` | The key in the JSON payload that stores the user's roles. The value must be a comma-separated list of roles. This key is required only if you want to use roles in the JWT. You can configure `roles_key` as a list to extract roles from nested JWT claims.
68+
`required_audience` | The name of the audience that the JWT must specify. You can set a single value (for example, `project1`) or multiple comma-separated values (for example, `project1,admin`). If you set multiple values, the JWT must have at least one required audience. This parameter corresponds to the [`aud` claim of the JWT](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3).
69+
`required_issuer` | The target issuer of JWT stored in the JSON payload. This corresponds to the [`iss` claim of the JWT](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1).
70+
`jwt_clock_skew_tolerance_seconds` | Sets a window of time, in seconds, to compensate for any disparity between the JWT authentication server and OpenSearch node clock times, thereby preventing authentication failures due to the misalignment. Security sets 30 seconds as the default. Use this setting to apply a custom value.
6771

6872

6973
## OpenID Connect URL

0 commit comments

Comments
 (0)