Skip to content

Commit

Permalink
Adding doc for the new API introduced by elastic#64517 - /_security/s…
Browse files Browse the repository at this point in the history
…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
BigPandaToo and lcawl committed Nov 17, 2020
1 parent 46c99ec commit 844d2ee
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions x-pack/docs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ testClusters.integTest {
setting 'xpack.security.authc.realms.pki.pki1.certificate_authorities', '[ "testClient.crt" ]'
setting 'xpack.security.authc.realms.pki.pki1.delegation.enabled', 'true'
setting 'xpack.security.authc.realms.saml.saml1.order', '4'
setting 'xpack.security.authc.realms.saml.saml1.sp.logout', 'https://kibana.org/logout'
setting 'xpack.security.authc.realms.saml.saml1.idp.entity_id', 'https://my-idp.org'
setting 'xpack.security.authc.realms.saml.saml1.idp.metadata.path', 'idp-docs-metadata.xml'
setting 'xpack.security.authc.realms.saml.saml1.sp.entity_id', 'https://kibana.org'
Expand Down
2 changes: 2 additions & 0 deletions x-pack/docs/en/rest-api/security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ realm when using a custom web application other than Kibana
* <<security-api-saml-authenticate, Submit an authentication response>>
* <<security-api-saml-logout, Logout an authenticated user>>
* <<security-api-saml-invalidate, Submit a logout request from the IdP>>
* <<security-api-saml-sp-metadata,Generate SAML metadata>>


include::security/authenticate.asciidoc[]
Expand Down Expand Up @@ -141,4 +142,5 @@ include::security/saml-prepare-authentication-api.asciidoc[]
include::security/saml-authenticate-api.asciidoc[]
include::security/saml-logout-api.asciidoc[]
include::security/saml-invalidate-api.asciidoc[]
include::security/saml-sp-metadata.asciidoc[]
include::security/ssl.asciidoc[]
49 changes: 49 additions & 0 deletions x-pack/docs/en/rest-api/security/saml-sp-metadata.asciidoc
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>"
}
--------------------------------------------------

0 comments on commit 844d2ee

Please sign in to comment.