[[reference-security-saml_prepare_authentication]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.samlPrepareAuthentication

Prepare SAML authentication. Creates a SAML authentication request (`<AuthnRequest>`) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.

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

[discrete]
==== Function signature

[source,ts]
----
(SecuritySamlPrepareAuthenticationRequest, options?): Promise<SecuritySamlPrepareAuthenticationResponse>
----

[discrete]
===== `SecuritySamlPrepareAuthenticationRequest`

[source,ts]
----
interface SecuritySamlPrepareAuthenticationRequest extends <<shared-type-request-base, RequestBase>> {
  acs?: string
  realm?: string
  relay_state?: string
}
----

[discrete]
===== `SecuritySamlPrepareAuthenticationResponse`

[source,ts]
----
interface SecuritySamlPrepareAuthenticationResponse {
  id: <<shared-type-id, Id>>
  realm: string
  redirect: string
}
----