Skip to content

Commit ed189b3

Browse files
committed
Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm}
Related to elastic#49018
1 parent 7dfdb34 commit ed189b3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

x-pack/docs/build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ testClusters.integTest {
5656
setting 'xpack.security.authc.realms.pki.pki1.certificate_authorities', '[ "testClient.crt" ]'
5757
setting 'xpack.security.authc.realms.pki.pki1.delegation.enabled', 'true'
5858
setting 'xpack.security.authc.realms.saml.saml1.order', '4'
59-
setting 'xpack.security.authc.realms.saml.saml1.sp.logout', 'https://kibana.example.com/logout'
59+
setting 'xpack.security.authc.realms.saml.saml1.sp.logout', 'https://kibana.org/logout'
6060
setting 'xpack.security.authc.realms.saml.saml1.idp.entity_id', 'https://my-idp.org'
6161
setting 'xpack.security.authc.realms.saml.saml1.idp.metadata.path', 'idp-docs-metadata.xml'
6262
setting 'xpack.security.authc.realms.saml.saml1.sp.entity_id', 'https://kibana.org'

x-pack/docs/en/rest-api/security/saml-sp-metadata.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Generate SAML metadata for a SAML 2.0 Service Provider.
1515
The SAML 2.0 specification provides a mechanism for Service Providers to
1616
describe their capabilities and configuration using a metadata file. This API
1717
generates Service Provider metadata, based on the configuration of a SAML realm
18-
in Elasticsearch.
18+
in {es}.
1919

2020
[[security-api-saml-sp-metadata-path-params]]
2121
==== {api-path-parms-title}
@@ -39,11 +39,11 @@ SAML realm `saml1`:
3939
--------------------------------------------------
4040
GET /_security/saml/metadata/saml1
4141
--------------------------------------------------
42-
The API returns the following response:
42+
The API returns the following response containing the SAML metadata as an XML string:
4343

4444
[source,console-result]
4545
--------------------------------------------------
4646
{
47-
"metadata" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://kibana.org\"><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.org/api/security/saml/callback\" index=\"1\" isDefault=\"true\"/></md:SPSSODescriptor></md:EntityDescriptor>"
47+
"metadata" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://kibana.org\"><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.org/logout\"/><md:AssertionConsumerService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://kibana.org/api/security/saml/callback\" index=\"1\" isDefault=\"true\"/></md:SPSSODescriptor></md:EntityDescriptor>"
4848
}
4949
--------------------------------------------------

0 commit comments

Comments
 (0)