Saml2AuthenticatedPrincipal (spring-security-docs 5.7.0-M2 API)

All Superinterfaces:

AuthenticatedPrincipal

All Known Implementing Classes:

DefaultSaml2AuthenticatedPrincipal
```
public interface Saml2AuthenticatedPrincipal
extends AuthenticatedPrincipal
```
Saml2 representation of an AuthenticatedPrincipal.

Since:

5.2.2

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default <A> java.util.List<A>`	`getAttribute(java.lang.String name)`	Get the Saml2 token attribute by name
`default java.util.Map<java.lang.String,java.util.List<java.lang.Object>>`	`getAttributes()`	Get the Saml2 token attributes
`default <A> A`	`getFirstAttribute(java.lang.String name)`	Get the first value of Saml2 token attribute by name
`default java.lang.String`	`getRelyingPartyRegistrationId()`	Get the `RelyingPartyRegistration` identifier
`default java.util.List<java.lang.String>`	`getSessionIndexes()`

Methods inherited from interface org.springframework.security.core.AuthenticatedPrincipal
getName

- Method Detail
  - getFirstAttribute
```
@Nullable
default <A> A getFirstAttribute(java.lang.String name)
```
    Get the first value of Saml2 token attribute by name
    
    Type Parameters:
    
    A - the type of the attribute
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    the first attribute value or null otherwise
    
    Since:
    
    5.4
  - getAttribute
```
@Nullable
default <A> java.util.List<A> getAttribute(java.lang.String name)
```
    Get the Saml2 token attribute by name
    
    Type Parameters:
    
    A - the type of the attribute
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    the attribute or null otherwise
    
    Since:
    
    5.4
  - getAttributes
```
default java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getAttributes()
```
    Get the Saml2 token attributes
    
    Returns:
    
    the Saml2 token attributes
    
    Since:
    
    5.4
  - getRelyingPartyRegistrationId
```
default java.lang.String getRelyingPartyRegistrationId()
```
    Get the RelyingPartyRegistration identifier
    
    Returns:
    
    the RelyingPartyRegistration identifier
    
    Since:
    
    5.6
  - getSessionIndexes
```
default java.util.List<java.lang.String> getSessionIndexes()
```