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

Including info on OpenID Additional Parameters #5600

Merged
Changes from 1 commit
Commits
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
13 changes: 13 additions & 0 deletions _security/authentication-backends/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,19 @@
To include OpenID Connect with other authentication types in the Dashboards sign-in window, see [Configuring sign-in options]({{site.url}}{{site.baseurl}}/security/configuration/multi-auth/).
{: .note }

### Additional Parameters

Check failure on line 339 in _security/authentication-backends/openid-connect.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'Additional Parameters' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'Additional Parameters' is a heading and should be in sentence case.", "location": {"path": "_security/authentication-backends/openid-connect.md", "range": {"start": {"line": 339, "column": 5}}}, "severity": "ERROR"}

Some identity providers (IdP) may require custom parameters for the authentication process. The opensearch_dashboards.yml configuration file can be enhanced to include custom parameters under the opensearch_security.openid.additional_parameters namespace. These additional parameters are included in the GET request sent to the identity provider. This feature allows for greater flexibility and customization when communicating with various IdPs.
samuelcostae marked this conversation as resolved.
Show resolved Hide resolved

You can add any number of custom parameters. For example:
samuelcostae marked this conversation as resolved.
Show resolved Hide resolved

```
opensearch_security.openid.additional_parameters.foo: "bar"
opensearch_security.openid.additional_parameters.acr_values: "1"
```

samuelcostae marked this conversation as resolved.
Show resolved Hide resolved
In this example, two custom parameters, foo and acr_values, are added with values bar and 1, respectively. These parameters are appended to the GET request sent to the IdP.
samuelcostae marked this conversation as resolved.
Show resolved Hide resolved


#### Session management with additional cookies

Expand Down