Skip to content

Commit

Permalink
Adding doc for the new API introduced by elastic#64517 - /_security/s…
Browse files Browse the repository at this point in the history
…aml/metadata/{realm}

Related to elastic#49018
  • Loading branch information
BigPandaToo committed Nov 16, 2020
1 parent d3a57fb commit b44b4a9
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions x-pack/docs/en/rest-api/security/saml_sp_metadata.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[role="xpack"]
[[security-api-saml-sp-metadata]]
=== SAML sp metadata API
=== SAML service provider metadata API

Generate a SAML 2.0 Service Provider Metadata.
Generate SAML metadata for a SAML 2.0 Service Provider.

[[security-api-saml-sp-metadata-request]]
==== {api-request-title}

`POST /_security/saml/metadata/<realmname>`
`GET /_security/saml/metadata/<realmname>`

[[security-api-saml-sp-metadata-desc]]
==== {api-description-title}
Expand All @@ -21,12 +21,12 @@ in Elasticsearch.
==== {api-response-body-title}

`metadata`::
(string) An XML string that contains a SAML Service Providers metadata for the realm.
(string) An XML string that contains a SAML Service Provider's metadata for the realm.

[[security-api-saml-sp-metadata-example]]
==== {api-examples-title}

The following example generate Service Provider metadata for
The following example generates Service Provider metadata for
SAML realm `saml1`:

[source,console]
Expand All @@ -35,10 +35,9 @@ GET /_security/saml/metadata/saml1
--------------------------------------------------
The API returns the following response:

[source,js]
[source,console-result]
--------------------------------------------------
{
"metadata" : "<?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://kibana.example.com/"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://kibana.example.com/logout"/><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://kibana.example.com/api/security/v1/saml" index="1" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>"
}
--------------------------------------------------
// NOTCONSOLE

0 comments on commit b44b4a9

Please sign in to comment.