Files
elasticsearch-js/docs/reference-security-saml_service_provider_metadata.asciidoc
2024-12-05 14:46:52 -06:00

74 lines
4.1 KiB
Plaintext

[[reference-security-saml_service_provider_metadata]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.samlServiceProviderMetadata]]
=== client.security.samlServiceProviderMetadata
Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider.
{ref}/security-api-saml-sp-metadata.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecuritySamlServiceProviderMetadataRequest, options?): Promise<SecuritySamlServiceProviderMetadataResponse>
----
[discrete]
==== SecuritySamlServiceProviderMetadataRequest
[pass]
++++
<pre>
++++
interface SecuritySamlServiceProviderMetadataRequest extends <<RequestBase>> {
realm_name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== SecuritySamlServiceProviderMetadataResponse
[pass]
++++
<pre>
++++
interface SecuritySamlServiceProviderMetadataResponse {
metadata: string
}
[pass]
++++
</pre>
++++