Add RelayState in the saml-prepare-auth docs (#76979) (#79570)

Support for RelayState was introduced in #46534 but the docs were not updated at the time.
elastic · Oct 20, 2021 · 3e6393b · 3e6393b
1 parent f662dc1
commit 3e6393b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/x-pack/docs/en/rest-api/security/saml-prepare-authentication-api.asciidoc b/x-pack/docs/en/rest-api/security/saml-prepare-authentication-api.asciidoc
@@ -51,6 +51,11 @@ clients. See also <<security-api-saml-authenticate,SAML authenticate API>>,
   used to generate the authentication request. You must specify either this parameter or the `acs`
   parameter.
 
+`relay_state`::
+  (Optional, string) A string that will be included in the redirect URL that this API returns
+  as the `RelayState` query parameter. If the Authentication Request is signed, this value is
+  used as part of the signature computation.
+
 [[security-api-saml-prepare-authentication-response-body]]
 ==== {api-response-body-title}