forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding doc for the new API introduced by elastic#64517 - /_security/s…
…aml/metadata/{realm} (elastic#65065) * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 * This change adds realm name of the realm used to perform authentication to the responses of _security/oidc/authenticate and _security/oidc/authenticate APIs Resolves elastic#53161 * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 * [DOCS] Adds API to navigation tree * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 * Adding doc for the new API introduced by elastic#64517 - /_security/saml/metadata/{realm} Related to elastic#49018 Co-authored-by: lcawl <lcawley@elastic.co>
- Loading branch information
1 parent
46c99ec
commit 844d2ee
Showing
3 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
x-pack/docs/en/rest-api/security/saml-sp-metadata.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
[role="xpack"] | ||
[[security-api-saml-sp-metadata]] | ||
=== SAML service provider metadata API | ||
|
||
Generate SAML metadata for a SAML 2.0 Service Provider. | ||
|
||
[[security-api-saml-sp-metadata-request]] | ||
==== {api-request-title} | ||
|
||
`GET /_security/saml/metadata/<realm_name>` | ||
|
||
[[security-api-saml-sp-metadata-desc]] | ||
==== {api-description-title} | ||
|
||
The SAML 2.0 specification provides a mechanism for Service Providers to | ||
describe their capabilities and configuration using a metadata file. This API | ||
generates Service Provider metadata, based on the configuration of a SAML realm | ||
in {es}. | ||
|
||
[[security-api-saml-sp-metadata-path-params]] | ||
==== {api-path-parms-title} | ||
|
||
`<realm_name>`:: | ||
(Required, string) The name of the SAML realm in {es}. | ||
|
||
[[security-api-saml-sp-metadata-response-body]] | ||
==== {api-response-body-title} | ||
|
||
`metadata`:: | ||
(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 generates Service Provider metadata for | ||
SAML realm `saml1`: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
GET /_security/saml/metadata/saml1 | ||
-------------------------------------------------- | ||
The API returns the following response containing the SAML metadata as an XML string: | ||
|
||
[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.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>" | ||
} | ||
-------------------------------------------------- |