Skip to content

Commit 7dfdb34

Browse files
committed
Merge branch 'SAML_API_doc' of github.com:BigPandaToo/elasticsearch into SAML_API_doc
2 parents 64adf7f + f7df5ab commit 7dfdb34

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

x-pack/docs/en/rest-api/security.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ realm when using a custom web application other than Kibana
103103
* <<security-api-saml-authenticate, Submit an authentication response>>
104104
* <<security-api-saml-logout, Logout an authenticated user>>
105105
* <<security-api-saml-invalidate, Submit a logout request from the IdP>>
106+
* <<security-api-saml-sp-metadata,Generate SAML metadata>>
106107

107108

108109
include::security/authenticate.asciidoc[]
@@ -141,4 +142,5 @@ include::security/saml-prepare-authentication-api.asciidoc[]
141142
include::security/saml-authenticate-api.asciidoc[]
142143
include::security/saml-logout-api.asciidoc[]
143144
include::security/saml-invalidate-api.asciidoc[]
145+
include::security/saml-sp-metadata.asciidoc[]
144146
include::security/ssl.asciidoc[]

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

+10-4
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@ Generate SAML metadata for a SAML 2.0 Service Provider.
77
[[security-api-saml-sp-metadata-request]]
88
==== {api-request-title}
99

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

1212
[[security-api-saml-sp-metadata-desc]]
1313
==== {api-description-title}
1414

15-
The SAML 2.0 specification provides a mechanism for Service Providers to describe their
16-
capabilities and configuration using a metadata file.
17-
This API generates Service Provider metadata, based on the configuration of a SAML realm
15+
The SAML 2.0 specification provides a mechanism for Service Providers to
16+
describe their capabilities and configuration using a metadata file. This API
17+
generates Service Provider metadata, based on the configuration of a SAML realm
1818
in Elasticsearch.
1919

20+
[[security-api-saml-sp-metadata-path-params]]
21+
==== {api-path-parms-title}
22+
23+
`<realm_name>`::
24+
(Required, string) The name of the SAML realm in {es}.
25+
2026
[[security-api-saml-sp-metadata-response-body]]
2127
==== {api-response-body-title}
2228

0 commit comments

Comments
 (0)