Skip to content

Commit b44b4a9

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

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[role="xpack"]
22
[[security-api-saml-sp-metadata]]
3-
=== SAML sp metadata API
3+
=== SAML service provider metadata API
44

5-
Generate a SAML 2.0 Service Provider Metadata.
5+
Generate SAML metadata for a SAML 2.0 Service Provider.
66

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

10-
`POST /_security/saml/metadata/<realmname>`
10+
`GET /_security/saml/metadata/<realmname>`
1111

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

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

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

29-
The following example generate Service Provider metadata for
29+
The following example generates Service Provider metadata for
3030
SAML realm `saml1`:
3131

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

38-
[source,js]
38+
[source,console-result]
3939
--------------------------------------------------
4040
{
4141
"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>"
4242
}
4343
--------------------------------------------------
44-
// NOTCONSOLE

0 commit comments

Comments
 (0)