インターフェース StandardClaimAccessor
- すべてのスーパーインターフェース:
ClaimAccessor
- すべての既知のサブインターフェース:
IdTokenClaimAccessor
,OidcUser
- すべての既知の実装クラス:
DefaultOidcUser
、OidcIdToken
、OidcUserInfo
public interface StandardClaimAccessor extends ClaimAccessor
「標準クレーム」のClaimAccessor
これは、UserInfo レスポンスまたは ID トークンで返すことができます。- 導入:
- 5.0
- 関連事項:
ClaimAccessor
,StandardClaimNames
,OidcUserInfo
, UserInfo レスポンス , 標準クレーム
メソッドのサマリー
すべてのメソッド インスタンスメソッド デフォルトメソッド 修飾子と型 メソッド 説明 default AddressStandardClaim
getAddress()
ユーザーの希望する住所(address)
を返します。default java.lang.String
getBirthdate()
ユーザーの生年月日(birthdate)
を返します。default java.lang.String
getEmail()
ユーザーの優先メールアドレス(email)
を返します。default java.lang.Boolean
getEmailVerified()
ユーザーのメールアドレスが(email_verified)
であることが確認されている場合はtrue
を返し、それ以外の場合はfalse
を返します。default java.lang.String
getFamilyName()
ユーザーの姓または姓(family_name)
を返します。default java.lang.String
getFullName()
ユーザーのフルネーム(name)
を表示可能な形式で返します。default java.lang.String
getGender()
ユーザーの性別(gender)
を返します。default java.lang.String
getGivenName()
ユーザーの名または名(given_name)
を返します。default java.lang.String
getLocale()
ユーザーのロケール(locale)
を返します。default java.lang.String
getMiddleName()
ユーザーのミドルネーム(middle_name)
を返します。default java.lang.String
getNickName()
ユーザーのニックネーム(nickname)
を返します。これは、(given_name)
と同じであってもなくてもかまいません。default java.lang.String
getPhoneNumber()
ユーザーの優先電話番号(phone_number)
を返します。default java.lang.Boolean
getPhoneNumberVerified()
ユーザーの電話番号が(phone_number_verified)
であることが確認されている場合はtrue
を返し、それ以外の場合はfalse
を返します。default java.lang.String
getPicture()
ユーザーのプロフィール写真(picture)
の URL を返します。default java.lang.String
getPreferredUsername()
ユーザーが参照したい優先ユーザー名(preferred_username)
を返します。default java.lang.String
getProfile()
ユーザーのプロファイルページ(profile)
の URL を返します。default java.lang.String
getSubject()
サブジェクト識別子(sub)
を返します。default java.time.Instant
getUpdatedAt()
ユーザーの情報が最後に更新された時刻(updated_at)
を返します。default java.lang.String
getWebsite()
ユーザーの Web ページまたはブログ(website)
の URL を返します。default java.lang.String
getZoneInfo()
ユーザーのタイムゾーン(zoneinfo)
を返します。インターフェース org.springframework.security.oauth2.core.ClaimAccessor から継承されたメソッド
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim
メソッドの詳細
getSubject
default java.lang.String getSubject()
サブジェクト識別子(sub)
を返します。- 戻り値:
- サブジェクト識別子
getFullName
default java.lang.String getFullName()
ユーザーのフルネーム(name)
を表示可能な形式で返します。- 戻り値:
- ユーザーのフルネーム
getGivenName
default java.lang.String getGivenName()
ユーザーの名または名(given_name)
を返します。- 戻り値:
- ユーザーの名
getFamilyName
default java.lang.String getFamilyName()
ユーザーの姓または姓(family_name)
を返します。- 戻り値:
- ユーザーの姓
getMiddleName
default java.lang.String getMiddleName()
ユーザーのミドルネーム(middle_name)
を返します。- 戻り値:
- ユーザーのミドルネーム
getNickName
default java.lang.String getNickName()
ユーザーのニックネーム(nickname)
を返します。これは、(given_name)
と同じであってもなくてもかまいません。- 戻り値:
- ユーザーのニックネーム
getPreferredUsername
default java.lang.String getPreferredUsername()
ユーザーが参照したい優先ユーザー名(preferred_username)
を返します。- 戻り値:
- ユーザーの優先ユーザー名
getProfile
default java.lang.String getProfile()
ユーザーのプロファイルページ(profile)
の URL を返します。- 戻り値:
- ユーザーのプロフィールページの URL
getPicture
default java.lang.String getPicture()
ユーザーのプロフィール写真(picture)
の URL を返します。- 戻り値:
- ユーザーのプロフィール写真の URL
getWebsite
default java.lang.String getWebsite()
ユーザーの Web ページまたはブログ(website)
の URL を返します。- 戻り値:
- ユーザーの Web ページまたはブログの URL
getEmail
default java.lang.String getEmail()
ユーザーの優先メールアドレス(email)
を返します。- 戻り値:
- ユーザーの希望するメールアドレス
getEmailVerified
default java.lang.Boolean getEmailVerified()
ユーザーのメールアドレスが(email_verified)
であることが確認されている場合はtrue
を返し、それ以外の場合はfalse
を返します。- 戻り値:
- ユーザーのメールアドレスが確認されている場合は
true
、それ以外の場合はfalse
getGender
default java.lang.String getGender()
ユーザーの性別(gender)
を返します。- 戻り値:
- ユーザーの性別
getBirthdate
default java.lang.String getBirthdate()
ユーザーの生年月日(birthdate)
を返します。- 戻り値:
- ユーザーの生年月日
getZoneInfo
default java.lang.String getZoneInfo()
ユーザーのタイムゾーン(zoneinfo)
を返します。- 戻り値:
- ユーザーのタイムゾーン
getLocale
default java.lang.String getLocale()
ユーザーのロケール(locale)
を返します。- 戻り値:
- ユーザーのロケール
getPhoneNumber
default java.lang.String getPhoneNumber()
ユーザーの優先電話番号(phone_number)
を返します。- 戻り値:
- ユーザーの優先電話番号
getPhoneNumberVerified
default java.lang.Boolean getPhoneNumberVerified()
ユーザーの電話番号が(phone_number_verified)
であることが確認されている場合はtrue
を返し、それ以外の場合はfalse
を返します。- 戻り値:
- ユーザーの電話番号が確認されている場合は
true
、それ以外の場合はfalse
getAddress
default AddressStandardClaim getAddress()
ユーザーの希望する住所(address)
を返します。- 戻り値:
- ユーザーの優先住所
getUpdatedAt
default java.time.Instant getUpdatedAt()
ユーザーの情報が最後に更新された時刻(updated_at)
を返します。- 戻り値:
- ユーザーの情報が最後に更新された時刻