-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Adding doc for the new API introduced by #64517 - /_security/saml/metadata/{realm} #65065
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
50cf25a
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo d3a57fb
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo b44b4a9
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo 3e03d58
This change adds realm name of the realm used to perform authenticati…
BigPandaToo d9a7e2e
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo f7df5ab
[DOCS] Adds API to navigation tree
lcawl 64adf7f
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo 7dfdb34
Merge branch 'SAML_API_doc' of github.com:BigPandaToo/elasticsearch i…
BigPandaToo ed189b3
Adding doc for the new API introduced by #64517 - /_security/saml/met…
BigPandaToo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
x-pack/docs/en/rest-api/security/saml_sp_metadata.asciidoc
This file contains hidden or 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,44 @@ | ||
[role="xpack"] | ||
[[security-api-saml-sp-metadata]] | ||
=== SAML sp metadata API | ||
|
||
Generate a SAML 2.0 Service Provider Metadata. | ||
BigPandaToo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[[security-api-saml-sp-metadata-request]] | ||
==== {api-request-title} | ||
|
||
`POST /_security/saml/metadata/<realmname>` | ||
BigPandaToo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[[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 Elasticsearch. | ||
|
||
[[security-api-saml-sp-metadata-response-body]] | ||
==== {api-response-body-title} | ||
|
||
`metadata`:: | ||
(string) An XML string that contains a SAML Service Providers metadata for the realm. | ||
BigPandaToo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[[security-api-saml-sp-metadata-example]] | ||
==== {api-examples-title} | ||
|
||
The following example generate Service Provider metadata for | ||
BigPandaToo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
SAML realm `saml1`: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
GET /_security/saml/metadata/saml1 | ||
-------------------------------------------------- | ||
The API returns the following response: | ||
|
||
[source,js] | ||
-------------------------------------------------- | ||
{ | ||
"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 | ||
BigPandaToo marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.