Skip to content

Commit 4440020

Browse files
Update SAML docs to point to correct api url
Closes gh-9953
1 parent c2b9c08 commit 4440020

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

docs/manual/spring-security-docs-manual.gradle

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ asciidoctorj {
2020
def ghOldSamplesUrl = "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
2121
def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch"
2222
def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag"
23-
def oldSecurityApiUrl = "https://docs.spring.io/spring-security/site/docs/5.4.x/api/"
2423
def securityApiUrl = "$securityDocsUrl/api/"
2524
def securityReferenceUrl = "$securityDocsUrl/reference/html5/"
2625
def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/"
@@ -31,7 +30,6 @@ asciidoctorj {
3130
'gh-url': ghUrl,
3231
'gh-samples-url': ghSamplesUrl,
3332
'gh-old-samples-url': ghOldSamplesUrl,
34-
'old-security-api-url': oldSecurityApiUrl,
3533
'security-api-url': securityApiUrl,
3634
'security-reference-url': securityReferenceUrl,
3735
'spring-framework-api-url': springFrameworkApiUrl,

docs/manual/src/docs/asciidoc/_includes/servlet/saml2/saml2-login.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ class MyCustomSecurityConfiguration : WebSecurityConfigurerAdapter() {
319319
The above requires the role of `USER` for any URL that starts with `/messages/`.
320320

321321
[[servlet-saml2login-relyingpartyregistrationrepository]]
322-
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.
322+
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.
323323
This includes things like the location of the SSO endpoint the relying party should use when requesting authentication from the asserting party.
324324

325325
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
422422

423423
[[servlet-saml2login-relyingpartyregistration]]
424424
=== RelyingPartyRegistration
425-
A {old-security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.html[`RelyingPartyRegistration`]
425+
A {security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.html[`RelyingPartyRegistration`]
426426
instance represents a link between an relying party and assering party's metadata.
427427

428428
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.

0 commit comments

Comments
 (0)