org.springframework.security.oauth2.core.oidc

Interface OidcScopes

public interface OidcScopes

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:

StandardClaimNames, Requesting Claims using Scope Values

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDRESS The address scope requests access to the address claim.
static java.lang.String	EMAIL The email scope requests access to the email and email_verified claims.
static java.lang.String	OPENID The openid scope is required for OpenID Connect Authentication Requests.
static java.lang.String	PHONE The phone scope requests access to the phone_number and phone_number_verified claims.
static java.lang.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.

Field Detail

OPENID

static final java.lang.String OPENID

The openid scope is required for OpenID Connect Authentication Requests.

See Also:

Constant Field Values

PROFILE

static final java.lang.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:

Constant Field Values

EMAIL

static final java.lang.String EMAIL

The email scope requests access to the email and email_verified claims.

See Also:

Constant Field Values

ADDRESS

static final java.lang.String ADDRESS

The address scope requests access to the address claim.

See Also:

Constant Field Values

PHONE

static final java.lang.String PHONE

The phone scope requests access to the phone_number and phone_number_verified claims.

See Also:

Constant Field Values