Package org.springframework.security.oauth2.core.oidc.user

Class OidcUserAuthority

java.lang.Object

org.springframework.security.oauth2.core.user.OAuth2UserAuthority

org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

All Implemented Interfaces:

Serializable, GrantedAuthority

public class OidcUserAuthority
extends OAuth2UserAuthority

A GrantedAuthority that may be associated to an OidcUser.

Since:

5.0

See Also:

• OidcUser
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OidcUserAuthority(String authority, OidcIdToken idToken, OidcUserInfo userInfo)	Constructs a OidcUserAuthority using the provided parameters.
OidcUserAuthority(String authority, OidcIdToken idToken, OidcUserInfo userInfo, String userNameAttributeName)	Constructs a OidcUserAuthority using the provided parameters.
OidcUserAuthority(OidcIdToken idToken)	Constructs a OidcUserAuthority using the provided parameters.
OidcUserAuthority(OidcIdToken idToken, OidcUserInfo userInfo)	Constructs a OidcUserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to OIDC_USER.
OidcUserAuthority(OidcIdToken idToken, OidcUserInfo userInfo, String userNameAttributeName)	Constructs a OidcUserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to OIDC_USER.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
OidcIdToken	getIdToken()	Returns the ID Token containing claims about the user.
OidcUserInfo	getUserInfo()	Returns the UserInfo containing claims about the user, may be null.
int	hashCode()

Methods inherited from class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

getAttributes, getAuthority, getUserNameAttributeName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OidcUserAuthority

public OidcUserAuthority(OidcIdToken idToken)

Constructs a OidcUserAuthority using the provided parameters.

Parameters:

idToken - the ID Token containing claims about the user

OidcUserAuthority

public OidcUserAuthority(OidcIdToken idToken,
 OidcUserInfo userInfo)

Constructs a OidcUserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to OIDC_USER.

Parameters:

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

OidcUserAuthority

public OidcUserAuthority(OidcIdToken idToken,
 OidcUserInfo userInfo,
 @Nullable
 String userNameAttributeName)

Constructs a OidcUserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to OIDC_USER.

Parameters:

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

userNameAttributeName - the attribute name used to access the user's name from the attributes

Since:

6.4

OidcUserAuthority

public OidcUserAuthority(String authority,
 OidcIdToken idToken,
 OidcUserInfo userInfo)

Constructs a OidcUserAuthority using the provided parameters.

Parameters:

authority - the authority granted to the user

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

OidcUserAuthority

public OidcUserAuthority(String authority,
 OidcIdToken idToken,
 OidcUserInfo userInfo,
 @Nullable
 String userNameAttributeName)

Constructs a OidcUserAuthority using the provided parameters.

Parameters:

authority - the authority granted to the user

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

userNameAttributeName - the attribute name used to access the user's name from the attributes

Since:

6.4

Method Details

getIdToken

public OidcIdToken getIdToken()

Returns the ID Token containing claims about the user.

Returns:

the OidcIdToken containing claims about the user.

getUserInfo

public OidcUserInfo getUserInfo()

Returns the UserInfo containing claims about the user, may be null.

Returns:

the OidcUserInfo containing claims about the user, or null

equals

public boolean equals(Object obj)

Overrides:

equals in class OAuth2UserAuthority

hashCode

public int hashCode()

Overrides:

hashCode in class OAuth2UserAuthority