From 4440020217efa6212d522d49aed038e46580bc91 Mon Sep 17 00:00:00 2001 From: Marcus Da Coregio Date: Fri, 9 Jul 2021 11:08:39 -0300 Subject: [PATCH] Update SAML docs to point to correct api url Closes gh-9953 --- docs/manual/spring-security-docs-manual.gradle | 2 -- .../docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/manual/spring-security-docs-manual.gradle b/docs/manual/spring-security-docs-manual.gradle index b622b1730e..8baa629ae2 100644 --- a/docs/manual/spring-security-docs-manual.gradle +++ b/docs/manual/spring-security-docs-manual.gradle @@ -20,7 +20,6 @@ asciidoctorj { def ghOldSamplesUrl = "https://github.com/spring-projects/spring-security/tree/5.4.x/samples" def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch" def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag" - def oldSecurityApiUrl = "https://docs.spring.io/spring-security/site/docs/5.4.x/api/" def securityApiUrl = "$securityDocsUrl/api/" def securityReferenceUrl = "$securityDocsUrl/reference/html5/" def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/" @@ -31,7 +30,6 @@ asciidoctorj { 'gh-url': ghUrl, 'gh-samples-url': ghSamplesUrl, 'gh-old-samples-url': ghOldSamplesUrl, - 'old-security-api-url': oldSecurityApiUrl, 'security-api-url': securityApiUrl, 'security-reference-url': securityReferenceUrl, 'spring-framework-api-url': springFrameworkApiUrl, diff --git a/docs/manual/src/docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc b/docs/manual/src/docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc index e7b4bc35b2..d2833fc066 100644 --- a/docs/manual/src/docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc +++ b/docs/manual/src/docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc @@ -319,7 +319,7 @@ class MyCustomSecurityConfiguration : WebSecurityConfigurerAdapter() { The above requires the role of `USER` for any URL that starts with `/messages/`. [[servlet-saml2login-relyingpartyregistrationrepository]] -The second `@Bean` Spring Boot creates is a {old-security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.html[`RelyingPartyRegistrationRepository`], which represents the asserting party and relying party metadata. +The second `@Bean` Spring Boot creates is a {security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.html[`RelyingPartyRegistrationRepository`], which represents the asserting party and relying party metadata. This includes things like the location of the SSO endpoint the relying party should use when requesting authentication from the asserting party. You can override the default by publishing your own `RelyingPartyRegistrationRepository` bean. @@ -422,7 +422,7 @@ A relying party can be multi-tenant by registering more than one relying party i [[servlet-saml2login-relyingpartyregistration]] === RelyingPartyRegistration -A {old-security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.html[`RelyingPartyRegistration`] +A {security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.html[`RelyingPartyRegistration`] instance represents a link between an relying party and assering party's metadata. In a `RelyingPartyRegistration`, you can provide relying party metadata like its `Issuer` value, where it expects SAML Responses to be sent to, and any credentials that it owns for the purposes of signing or decrypting payloads.