RelyingPartyRegistration (spring-security-docs-manual 5.3.2.RELEASE API)

java.lang.Object
- org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration

public class RelyingPartyRegistration
extends java.lang.Object

Represents a configured service provider, SP, and a remote identity provider, IDP, pair. Each SP/IDP pair is uniquely identified using a registrationId, an arbitrary string. A fully configured registration may look like

                //remote IDP entity ID
                String idpEntityId = "https://simplesaml-for-spring-saml.cfapps.io/saml2/idp/metadata.php";
                //remote WebSSO Endpoint - Where to Send AuthNRequests to
                String webSsoEndpoint = "https://simplesaml-for-spring-saml.cfapps.io/saml2/idp/SSOService.php";
                //local registration ID
                String registrationId = "simplesamlphp";
                //local entity ID - autogenerated based on URL
                String localEntityIdTemplate = "{baseUrl}/saml2/service-provider-metadata/{registrationId}";
                //local SSO URL - autogenerated, endpoint to receive SAML Response objects
                String acsUrlTemplate = "{baseUrl}/login/saml2/sso/{registrationId}";
                //local signing (and local decryption key and remote encryption certificate)
                Saml2X509Credential signingCredential = getSigningCredential();
                //IDP certificate for verification of incoming messages
                Saml2X509Credential idpVerificationCertificate = getVerificationCertificate();
                RelyingPartyRegistration rp = RelyingPartyRegistration.withRegistrationId(registrationId)
                                .providerDetails(config -> config.entityId(idpEntityId));
                                .providerDetails(config -> config.webSsoUrl(url));
                                .credentials(c -> c.add(signingCredential))
                                .credentials(c -> c.add(idpVerificationCertificate))
                                .localEntityIdTemplate(localEntityIdTemplate)
                                .assertionConsumerServiceUrlTemplate(acsUrlTemplate)
                                .build();

Since:: 5.2

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelyingPartyRegistration.Builder`
`static class`	`RelyingPartyRegistration.ProviderDetails` Configuration for IDP SSO endpoint configuration

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAssertionConsumerServiceUrlTemplate()` returns the URL template for which ACS URL authentication requests should contain Possible variables are `baseUrl`, `registrationId`, `baseScheme`, `baseHost`, and `basePort`.
`java.util.List<Saml2X509Credential>`	`getCredentials()` Returns a list of configured credentials to be used in message exchanges between relying party, SP, and asserting party, IDP.
`java.util.List<Saml2X509Credential>`	`getDecryptionCredentials()`
`java.util.List<Saml2X509Credential>`	`getEncryptionCredentials()`
`java.lang.String`	`getIdpWebSsoUrl()` Deprecated. use `RelyingPartyRegistration.ProviderDetails.getWebSsoUrl()` from `getProviderDetails()`
`java.lang.String`	`getLocalEntityIdTemplate()` The local relying party, or Service Provider, can generate it's entity ID based on possible variables of `baseUrl`, `registrationId`, `baseScheme`, `baseHost`, and `basePort`, for example `{baseUrl}/saml2/service-provider-metadata/{registrationId}`
`RelyingPartyRegistration.ProviderDetails`	`getProviderDetails()` Returns specific configuration around the Identity Provider SSO endpoint
`java.lang.String`	`getRegistrationId()` Returns the unique relying party registration ID
`java.lang.String`	`getRemoteIdpEntityId()` Deprecated. use `RelyingPartyRegistration.ProviderDetails.getEntityId()` from `getProviderDetails()`
`java.util.List<Saml2X509Credential>`	`getSigningCredentials()`
`java.util.List<Saml2X509Credential>`	`getVerificationCredentials()`
`static RelyingPartyRegistration.Builder`	`withRegistrationId(java.lang.String registrationId)` Creates a `RelyingPartyRegistration` `RelyingPartyRegistration.ProviderDetails.Builder` with a known `registrationId`
`static RelyingPartyRegistration.Builder`	`withRelyingPartyRegistration(RelyingPartyRegistration registration)` Creates a `RelyingPartyRegistration` `RelyingPartyRegistration.ProviderDetails.Builder` based on an existing object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getRemoteIdpEntityId
```
@Deprecated
public java.lang.String getRemoteIdpEntityId()
```
    Deprecated. use RelyingPartyRegistration.ProviderDetails.getEntityId() from getProviderDetails()
    
    Returns the entity ID of the IDP, the asserting party.
    
    Returns:
    
    entity ID of the asserting party
  - getRegistrationId
```
public java.lang.String getRegistrationId()
```
    Returns the unique relying party registration ID
    
    Returns:
    
    registrationId
  - getAssertionConsumerServiceUrlTemplate
```
public java.lang.String getAssertionConsumerServiceUrlTemplate()
```
    returns the URL template for which ACS URL authentication requests should contain Possible variables are baseUrl, registrationId, baseScheme, baseHost, and basePort.
    
    Returns:
    
    string containing the ACS URL template, with or without variables present
  - getIdpWebSsoUrl
```
@Deprecated
public java.lang.String getIdpWebSsoUrl()
```
    Deprecated. use RelyingPartyRegistration.ProviderDetails.getWebSsoUrl() from getProviderDetails()
    
    Contains the URL for which to send the SAML 2 Authentication Request to initiate a single sign on flow.
    
    Returns:
    
    a IDP URL that accepts REDIRECT or POST binding for authentication requests
  - getProviderDetails
```
public RelyingPartyRegistration.ProviderDetails getProviderDetails()
```
    Returns specific configuration around the Identity Provider SSO endpoint
    
    Returns:
    
    the IDP SSO endpoint configuration
    
    Since:
    
    5.3
  - getLocalEntityIdTemplate
```
public java.lang.String getLocalEntityIdTemplate()
```
    The local relying party, or Service Provider, can generate it's entity ID based on possible variables of baseUrl, registrationId, baseScheme, baseHost, and basePort, for example {baseUrl}/saml2/service-provider-metadata/{registrationId}
    
    Returns:
    
    a string containing the entity ID or entity ID template
  - getCredentials
```
public java.util.List<Saml2X509Credential> getCredentials()
```
    Returns a list of configured credentials to be used in message exchanges between relying party, SP, and asserting party, IDP.
    
    Returns:
    
    a list of credentials
  - getVerificationCredentials
```
public java.util.List<Saml2X509Credential> getVerificationCredentials()
```
    Returns:
    
    a filtered list containing only credentials of type Saml2X509Credential.Saml2X509CredentialType.VERIFICATION. Returns an empty list of credentials are not found
  - getSigningCredentials
```
public java.util.List<Saml2X509Credential> getSigningCredentials()
```
    Returns:
    
    a filtered list containing only credentials of type Saml2X509Credential.Saml2X509CredentialType.SIGNING. Returns an empty list of credentials are not found
  - getEncryptionCredentials
```
public java.util.List<Saml2X509Credential> getEncryptionCredentials()
```
    Returns:
    
    a filtered list containing only credentials of type Saml2X509Credential.Saml2X509CredentialType.ENCRYPTION. Returns an empty list of credentials are not found
  - getDecryptionCredentials
```
public java.util.List<Saml2X509Credential> getDecryptionCredentials()
```
    Returns:
    
    a filtered list containing only credentials of type Saml2X509Credential.Saml2X509CredentialType.DECRYPTION. Returns an empty list of credentials are not found
  - withRegistrationId
```
public static RelyingPartyRegistration.Builder withRegistrationId(java.lang.String registrationId)
```
    Creates a RelyingPartyRegistration RelyingPartyRegistration.ProviderDetails.Builder with a known registrationId
    
    Parameters:
    
    registrationId - a string identifier for the RelyingPartyRegistration
    
    Returns:
    
    Builder to create a RelyingPartyRegistration object
  - withRelyingPartyRegistration
```
public static RelyingPartyRegistration.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration)
```
    Creates a RelyingPartyRegistration RelyingPartyRegistration.ProviderDetails.Builder based on an existing object
    
    Parameters:
    
    registration - the RelyingPartyRegistration
    
    Returns:
    
    Builder to create a RelyingPartyRegistration object

Class RelyingPartyRegistration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRemoteIdpEntityId

getRegistrationId

getAssertionConsumerServiceUrlTemplate

getIdpWebSsoUrl

getProviderDetails

getLocalEntityIdTemplate

getCredentials

getVerificationCredentials

getSigningCredentials

getEncryptionCredentials

getDecryptionCredentials

withRegistrationId

withRelyingPartyRegistration