LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

elasticsearch-saml-metadata

Generate SAML Service Provider metadata

TLDR

Generate SAML metadata
$ elasticsearch-saml-metadata
copy
Specify realm name
$ elasticsearch-saml-metadata --realm [realm_name]
copy
Output to file
$ elasticsearch-saml-metadata --out [metadata.xml]
copy
With signing certificate
$ elasticsearch-saml-metadata --signing-cert [cert.pem] --signing-key [key.pem]
copy

SYNOPSIS

elasticsearch-saml-metadata [options]

DESCRIPTION

elasticsearch-saml-metadata generates the SAML Service Provider metadata document that an Identity Provider needs in order to trust Elasticsearch. It reads the SAML realm configuration from elasticsearch.yml and writes the entity ID, the assertion consumer service URL, and the single logout endpoints into an XML file that can be handed to the IdP administrator.The realm must already be configured before running the command: the tool describes what is in the configuration, it does not create it.

PARAMETERS

--realm name

SAML realm to describe. Required when more than one SAML realm is configured.
--out file
Output file path. Defaults to saml-elasticsearch-metadata.xml.
--batch
Run without prompting for input.
--attribute name
Add a `<RequestedAttribute>` element for the named attribute. Repeatable.
--service-name name
Value for `<ServiceName>`. Defaults to "elasticsearch".
--locale name
Locale used for the metadata elements. Defaults to the JVM locale.
--contacts
Prompt for and include `<ContactPerson>` elements.
--organisation-name name
Include an `<Organization>` element with this name.
--organisation-display-name name
Display name for the organization.
--organisation-url url
URL for the organization.
--signing-cert file
PEM certificate used to sign the metadata.
--signing-key file
PEM private key matching the signing certificate.
--signing-key-password password
Password protecting the signing key.
--signing-bundle file
PKCS#12 file holding the signing key pair, as an alternative to the cert/key pair.
-E setting=value
Configure an Elasticsearch setting.

SEE ALSO

RESOURCES

Copied to clipboard
Kai