Skip to content

Commit

Permalink
Add doc reference for client_auth_method (#70124) (#70214)
Browse files Browse the repository at this point in the history
Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
  • Loading branch information
jkakavas authored Mar 10, 2021
1 parent 093096c commit c727627
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/reference/settings/security-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1629,6 +1629,23 @@ at the OpenID Connect Provider.
The OAuth 2.0 Client Secret that was assigned to {es} during registration
at the OpenID Connect Provider.

// tag::rp-client-auth-method-tag[]
`rp.client_auth_method` {ess-icon}::
(<<static-cluster-setting, Static>>)
The client authentication method used by {es} to authenticate
to the OpenID Connect Provider. Can be `client_secret_basic`, `client_secret_post`,
or `client_secret_jwt`. Defaults to `client_secret_basic`.
// end::rp-client-auth-method-tag[]

// tag::rp-client-auth-jwt-signature-algorithm[]
`rp.client_auth_signature_algorithm` {ess-icon}::
(<<static-cluster-setting, Static>>)
The signature algorithm that {es} uses to sign the JWT with which it authenticates
as a client to the OpenID Connect Provider when `client_secret_jwt` is selected for
`rp.client_auth_method`. Can be either `HS256`, `HS384`, or `HS512`. Defaults to
`HS384`.
// end::rp-client-auth-jwt-signature-algorithm[]

// tag::rp-redirect-uri-tag[]
`rp.redirect_uri` {ess-icon}::
(<<static-cluster-setting,Static>>)
Expand Down

0 comments on commit c727627

Please sign in to comment.