com.nimbusds.openid.connect.provider.spi.claims

Interface ClaimsSource

All Superinterfaces:

Lifecycle

public interface ClaimsSource
extends Lifecycle

Service Provider Interface (SPI) for sourcing OpenID Connect UserInfo and other claims about a subject.

Method Summary

Methods

Modifier and Type	Method and Description
com.nimbusds.openid.connect.sdk.claims.UserInfo	getClaims(com.nimbusds.oauth2.sdk.id.Subject subject, Set<String> claims, List<com.nimbusds.langtag.LangTag> claimsLocales) Requests claims for the specified subject.
Set<String>	supportedClaims() Returns the names of the supported OpenID Connect claims.

Methods inherited from interface com.nimbusds.openid.connect.provider.spi.Lifecycle

init, isEnabled, shutdown

Method Detail

supportedClaims

Set<String> supportedClaims()

Returns the names of the supported OpenID Connect claims.

Example:

 name
 email
 email_verified
 

Returns:

The supported claim names. Should not include the reserved sub (subject) claim name.

getClaims

com.nimbusds.openid.connect.sdk.claims.UserInfo getClaims(com.nimbusds.oauth2.sdk.id.Subject subject,
                                                        Set<String> claims,
                                                        List<com.nimbusds.langtag.LangTag> claimsLocales)
                                                          throws Exception

Requests claims for the specified subject.

Parameters:

subject - The subject. Must not be null.

claims - The names of the requested claims, with optional language tags. Must not be null.

claimsLocales - The preferred languages and scripts for the claims to return, null if not specified.

Returns:

The claims, null if the subject wasn't found or the claims source is disabled.

Throws:

Exception - If retrieval of the claims failed.