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

Class OidcScopes

java.lang.Object
org.springframework.security.oauth2.core.oidc.OidcScopes
public final class OidcScopes extends Object
The scope values defined by the OpenID Connect Core 1.0 specification that can be used to request claims.

The scope(s) associated to an OAuth2AccessToken determine what claims (resources) will be available when they are used to access OAuth 2.0 Protected Endpoints, such as the UserInfo Endpoint.

Since:
5.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADDRESS
    The address scope requests access to the address claim.
    static final String
    EMAIL
    The email scope requests access to the email and email_verified claims.
    static final String
    OPENID
    The openid scope is required for OpenID Connect Authentication Requests.
    static final String
    PHONE
    The phone scope requests access to the phone_number and phone_number_verified claims.
    static final String
    PROFILE
    The profile scope requests access to the default profile claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, updated_at.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • OPENID

      public static final String OPENID
      The openid scope is required for OpenID Connect Authentication Requests.
      See Also:

    • PROFILE

      public static final String PROFILE
      The profile scope requests access to the default profile claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, updated_at.
      See Also:

    • EMAIL

      public static final String EMAIL
      The email scope requests access to the email and email_verified claims.
      See Also:

    • ADDRESS

      public static final String ADDRESS
      The address scope requests access to the address claim.
      See Also:

    • PHONE

      public static final String PHONE
      The phone scope requests access to the phone_number and phone_number_verified claims.
      See Also: