Skip to content

Commit c727627

Browse files
authored
Add doc reference for client_auth_method (#70124) (#70214)
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.
1 parent 093096c commit c727627

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/reference/settings/security-settings.asciidoc

+17
Original file line numberDiff line numberDiff line change
@@ -1629,6 +1629,23 @@ at the OpenID Connect Provider.
16291629
The OAuth 2.0 Client Secret that was assigned to {es} during registration
16301630
at the OpenID Connect Provider.
16311631

1632+
// tag::rp-client-auth-method-tag[]
1633+
`rp.client_auth_method` {ess-icon}::
1634+
(<<static-cluster-setting, Static>>)
1635+
The client authentication method used by {es} to authenticate
1636+
to the OpenID Connect Provider. Can be `client_secret_basic`, `client_secret_post`,
1637+
or `client_secret_jwt`. Defaults to `client_secret_basic`.
1638+
// end::rp-client-auth-method-tag[]
1639+
1640+
// tag::rp-client-auth-jwt-signature-algorithm[]
1641+
`rp.client_auth_signature_algorithm` {ess-icon}::
1642+
(<<static-cluster-setting, Static>>)
1643+
The signature algorithm that {es} uses to sign the JWT with which it authenticates
1644+
as a client to the OpenID Connect Provider when `client_secret_jwt` is selected for
1645+
`rp.client_auth_method`. Can be either `HS256`, `HS384`, or `HS512`. Defaults to
1646+
`HS384`.
1647+
// end::rp-client-auth-jwt-signature-algorithm[]
1648+
16321649
// tag::rp-redirect-uri-tag[]
16331650
`rp.redirect_uri` {ess-icon}::
16341651
(<<static-cluster-setting,Static>>)

0 commit comments

Comments
 (0)