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

Interface ClaimsSupport

All Known Subinterfaces:
AdvancedClaimsSource, ClaimsSource, CommonClaimsSource
@ThreadSafe public interface ClaimsSupport
Interface for querying OpenID Connect claims support. Implementations must be thread-safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    supportedClaims()
    Returns the names of the supported OpenID Connect claims.

  • Method Details

    • supportedClaims

      Set<String> supportedClaims()
      Returns the names of the supported OpenID Connect claims.

      Wildcard character use:

      • Support for a pattern of claims can be indicated with the '*' wildcard character, e.g. "https://idp.example.com/*" for a set of claims having a common URI prefix.
      • Returning a single claim set to "*" indicates support for all requested claims (for a catch-all claim source).

      Example: 

       name
 email
 email_verified
      Returns:
      The supported claim names. Should not include the reserved sub (subject) claim name.