[[reference-security-saml_authenticate]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.security.samlAuthenticate

Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption.

{ref}/security-api-saml-authenticate.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SecuritySamlAuthenticateRequest, options?): Promise<SecuritySamlAuthenticateResponse>
----

[discrete]
==== SecuritySamlAuthenticateRequest

[pass]
++++
<pre>
++++
interface SecuritySamlAuthenticateRequest extends <<RequestBase>> {
  content: string
  ids: <<Ids>>
  realm?: string
}

[pass]
++++
</pre>
++++
[discrete]
==== SecuritySamlAuthenticateResponse

[pass]
++++
<pre>
++++
interface SecuritySamlAuthenticateResponse {
  access_token: string
  username: string
  expires_in: <<_integer, integer>>
  refresh_token: string
  realm: string
}

[pass]
++++
</pre>
++++