クラス OidcUserService

java.lang.ObjectSE
org.springframework.security.oauth2.client.oidc.userinfo.OidcUserService
実装されたすべてのインターフェース:
OAuth2UserService<OidcUserRequest,OidcUser>

public class OidcUserService extends ObjectSE implements OAuth2UserService<OidcUserRequest,OidcUser>
OpenID Connect 1.0 プロバイダーをサポートする OAuth2UserService の実装。
導入:
5.0
関連事項:
  • コンストラクターの詳細

    • OidcUserService

      public OidcUserService()
  • メソッドの詳細

    • createDefaultClaimTypeConverters

      public static MapSE<StringSE,org.springframework.core.convert.converter.Converter<ObjectSE,?>> createDefaultClaimTypeConverters()
      OidcUserInfo のクレーム値の型変換に使用されるデフォルト Converter を返します。
      戻り値:
      claim name によってキー設定された ConverterMapSE
      導入:
      5.2
    • loadUser

      public OidcUser loadUser(OidcUserRequest userRequest) throws OAuth2AuthenticationException
      インターフェースからコピーされた説明: OAuth2UserService
      UserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、OAuth2User を返します。
      次で指定:
      インターフェース OAuth2UserService<OidcUserRequest,OidcUser>loadUser 
      パラメーター:
      userRequest - ユーザーリクエスト
      戻り値:
      OAuth2User
      例外:
      OAuth2AuthenticationException - UserInfo エンドポイントからユーザー属性を取得しようとしてエラーが発生した場合
    • setOauth2UserService

      public final void setOauth2UserService(OAuth2UserService<OAuth2UserRequest,OAuth2User> oauth2UserService)
      ユーザー情報リソースをリクエストするときに使用される OAuth2UserService を設定します。
      パラメーター:
      oauth2UserService - ユーザー情報リソースをリクエストするときに使用される OAuth2UserService
      導入:
      5.1
    • setClaimTypeConverterFactory

      public final void setClaimTypeConverterFactory(FunctionSE<ClientRegistration,org.springframework.core.convert.converter.Converter<MapSE<StringSE,ObjectSE>,MapSE<StringSE,ObjectSE>>> claimTypeConverterFactory)
      OidcUserInfo のクレーム値の型変換に使用される Converter を提供するファクトリを設定します。デフォルトは、すべての clientsClaimTypeConverter です。
      パラメーター:
      claimTypeConverterFactory - 特定の client のクレーム値の型変換に使用される Converter を提供するファクトリ
      導入:
      5.2
    • setAccessibleScopes

      public final void setAccessibleScopes(SetSE<StringSE> accessibleScopes)
      ユーザー情報リソースへのアクセスを許可するスコープを設定します。デフォルトは profileemailaddress および phone です。スコープは、access token に関連付けられた「許可された」スコープに対してチェックされ、ユーザー情報リソースにアクセスできるかどうかが判別されます。少なくとも 1 つの一致がある場合、ユーザー情報リソースがリクエストされますが、そうでない場合はリクエストされません。
      パラメーター:
      accessibleScopes - ユーザー情報リソースへのアクセスを許可するスコープ
      導入:
      5.2