public class OIDCScopeValue extends Scope.Value
Related specifications:
Scope.Value.Requirement
Modifier and Type | Field and Description |
---|---|
static OIDCScopeValue |
ADDRESS
Requests that access to
address claim at the UserInfo
endpoint be granted by the issued access token. |
static OIDCScopeValue |
EMAIL
Requests that access to the
email and email_verified
claims at the UserInfo endpoint be granted by the issued access
token. |
static OIDCScopeValue |
OFFLINE_ACCESS
Requests that an OAuth 2.0 refresh token be issued that can be used
to obtain an access token that grants access the end-user's UserInfo
endpoint even when the user is not present (not logged in).
|
static OIDCScopeValue |
OPENID
Informs the authorisation server that the client is making an OpenID
Connect request (REQUIRED).
|
static OIDCScopeValue |
PHONE
Requests that access to the
phone_number and
phone_number_verified claims at the UserInfo endpoint be
granted by the issued access token. |
static OIDCScopeValue |
PROFILE
Requests that access to the end-user's default profile claims at the
UserInfo endpoint be granted by the issued access token.
|
DEFAULT_BYTE_LENGTH
Modifier and Type | Method and Description |
---|---|
Set<String> |
getClaimNames()
Returns the names of the associated claims.
|
Set<ClaimsRequest.Entry> |
toClaimsRequestEntries()
Gets the claims request entries for this OpenID Connect scope value.
|
net.minidev.json.JSONObject |
toClaimsRequestJSONObject()
Gets the claims request JSON object for this OpenID Connect scope
value.
|
static OIDCScopeValue[] |
values()
Returns the standard OpenID Connect scope values declared in this
class.
|
equals, getRequirement
compareTo, getValue, hashCode, toJSONString, toString
public static final OIDCScopeValue OPENID
sub
claim.public static final OIDCScopeValue PROFILE
name
, family_name
, given_name
,
middle_name
, nickname
, preferred_username
,
profile
, picture
, website
, gender
,
birthdate
, zoneinfo
, locale
, and
updated_at
.public static final OIDCScopeValue EMAIL
email
and email_verified
claims at the UserInfo endpoint be granted by the issued access
token.public static final OIDCScopeValue ADDRESS
address
claim at the UserInfo
endpoint be granted by the issued access token.public static final OIDCScopeValue PHONE
phone_number
and
phone_number_verified
claims at the UserInfo endpoint be
granted by the issued access token.public static final OIDCScopeValue OFFLINE_ACCESS
public static OIDCScopeValue[] values()
public Set<String> getClaimNames()
null
if not
applicable.public net.minidev.json.JSONObject toClaimsRequestJSONObject()
See OpenID Connect Core 1.0, section 5.1.
Example JSON object for "openid" scope value:
{ "sub" : { "essential" : true } }
Example JSON object for "email" scope value:
{ "email" : null, "email_verified" : null }
null
if not
applicable.public Set<ClaimsRequest.Entry> toClaimsRequestEntries()
See OpenID Connect Core 1.0, section 5.1.
null
if not applicable
(for scope values OPENID
and
OFFLINE_ACCESS
).Copyright © 2016 Connect2id Ltd.. All rights reserved.