パッケージ org.springframework.security.oauth2.core.oidc

インターフェース StandardClaimAccessor

すべてのスーパーインターフェース:
ClaimAccessor
すべての既知のサブインターフェース:
IdTokenClaimAccessor, OidcUser
すべての既知の実装クラス:
DefaultOidcUser、OidcIdToken、OidcUserInfo
public interface StandardClaimAccessor extends ClaimAccessor
「標準クレーム」の ClaimAccessor これは、UserInfo レスポンスまたは ID トークンで返すことができます。
導入:
5.0
関連事項:

  • メソッドの詳細

    • getSubject

      default StringSE getSubject()
      サブジェクト識別子 (sub) を返します。
      戻り値:
      サブジェクト識別子

    • getFullName

      default StringSE getFullName()
      ユーザーのフルネーム (name) を表示可能な形式で返します。
      戻り値:
      ユーザーのフルネーム

    • getGivenName

      default StringSE getGivenName()
      ユーザーの名または名 (given_name) を返します。
      戻り値:
      ユーザーの名

    • getFamilyName

      default StringSE getFamilyName()
      ユーザーの姓または姓 (family_name) を返します。
      戻り値:
      ユーザーの姓

    • getMiddleName

      default StringSE getMiddleName()
      ユーザーのミドルネーム (middle_name) を返します。
      戻り値:
      ユーザーのミドルネーム

    • getNickName

      default StringSE getNickName()
      ユーザーのニックネーム (nickname) を返します。これは、(given_name) と同じであってもなくてもかまいません。
      戻り値:
      ユーザーのニックネーム

    • getPreferredUsername

      default StringSE getPreferredUsername()
      ユーザーが参照したい優先ユーザー名 (preferred_username) を返します。
      戻り値:
      ユーザーの優先ユーザー名

    • getProfile

      default StringSE getProfile()
      ユーザーのプロファイルページ (profile) の URL を返します。
      戻り値:
      ユーザーのプロフィールページの URL

    • getPicture

      default StringSE getPicture()
      ユーザーのプロフィール写真 (picture) の URL を返します。
      戻り値:
      ユーザーのプロフィール写真の URL

    • getWebsite

      default StringSE getWebsite()
      ユーザーの Web ページまたはブログ (website) の URL を返します。
      戻り値:
      ユーザーの Web ページまたはブログの URL

    • getEmail

      default StringSE getEmail()
      ユーザーの優先メールアドレス (email) を返します。
      戻り値:
      ユーザーの希望するメールアドレス

    • getEmailVerified

      default BooleanSE getEmailVerified()
      ユーザーのメールアドレスが (email_verified) であることが確認されている場合は true を返し、それ以外の場合は false を返します。
      戻り値:
      ユーザーのメールアドレスが確認されている場合は true、それ以外の場合は false

    • getGender

      default StringSE getGender()
      ユーザーの性別 (gender) を返します。
      戻り値:
      ユーザーの性別

    • getBirthdate

      default StringSE getBirthdate()
      ユーザーの生年月日 (birthdate) を返します。
      戻り値:
      ユーザーの生年月日

    • getZoneInfo

      default StringSE getZoneInfo()
      ユーザーのタイムゾーン (zoneinfo) を返します。
      戻り値:
      ユーザーのタイムゾーン

    • getLocale

      default StringSE getLocale()
      ユーザーのロケール (locale) を返します。
      戻り値:
      ユーザーのロケール

    • getPhoneNumber

      default StringSE getPhoneNumber()
      ユーザーの優先電話番号 (phone_number) を返します。
      戻り値:
      ユーザーの優先電話番号

    • getPhoneNumberVerified

      default BooleanSE getPhoneNumberVerified()
      ユーザーの電話番号が (phone_number_verified) であることが確認されている場合は true を返し、それ以外の場合は false を返します。
      戻り値:
      ユーザーの電話番号が確認されている場合は true、それ以外の場合は false

    • getAddress

      default AddressStandardClaim getAddress()
      ユーザーの希望する住所 (address) を返します。
      戻り値:
      ユーザーの優先住所

    • getUpdatedAt

      default InstantSE getUpdatedAt()
      ユーザーの情報が最後に更新された時刻 (updated_at) を返します。
      戻り値:
      ユーザーの情報が最後に更新された時刻