クラス ClientRegistrations

java.lang.ObjectSE
org.springframework.security.oauth2.client.registration.ClientRegistrations

public final class ClientRegistrations extends ObjectSE
提供された発行者に基づいて、OpenID プロバイダーの構成または認可サーバーのメタデータから ClientRegistration.Builder を作成できます。
導入:
5.1
  • メソッドの詳細

    • fromOidcIssuerLocation

      public static ClientRegistration.Builder fromOidcIssuerLocation(StringSE issuer)
      OpenID プロバイダー構成リクエストを作成し、OpenID プロバイダーの構成レスポンスの値を使用して ClientRegistration.Builder を初期化することにより、提供された発行者を使用して ClientRegistration.Builder を作成します。

      例: 提供された発行者が "https://example.com" の場合、「OpenID プロバイダー構成リクエスト」が "https://example.com/.well-known/openid-configuration" に対して行われます。結果は「OpenID プロバイダー構成レスポンス」であると予想されます。

      使用例:

       ClientRegistration registration = ClientRegistrations.fromOidcIssuerLocation("https://example.com")
           .clientId("client-id")
           .clientSecret("client-secret")
           .build();
       
      パラメーター:
      issuer - 発行者
      戻り値:
      OpenID プロバイダー構成によって初期化された ClientRegistration.Builder
    • fromIssuerLocation

      public static ClientRegistration.Builder fromIssuerLocation(StringSE issuer)
      初期化に成功した最初のレスポンスの値を使用して、3 つの異なるディスカバリエンドポイントに順次クエリを実行することにより、提供された発行者を使用して ClientRegistration.Builder を作成します。エンドポイントが 200 または 4xx 以外のものを返す場合、メソッドは後続のエンドポイントを試行せずに終了します。issuer が host と path で構成されている場合、3 つのエンドポイントは次のように計算されます。
      1. RFC 8414 の互換性ノートで定義されている host/.well-known/openid-configuration/path
      2. OpenID プロバイダーの構成で定義されている issuer/.well-known/openid-configuration
      3. 認可サーバーのメタデータリクエストで定義されている host/.well-known/oauth-authorization-server/path
      2 番目のエンドポイントは fromOidcIssuerLocation(String) を呼び出すことと同じであることに注意してください。

      使用例:

       ClientRegistration registration = ClientRegistrations.fromIssuerLocation("https://example.com")
           .clientId("client-id")
           .clientSecret("client-secret")
           .build();
       
      パラメーター:
      issuer -
      戻り値:
      説明されているエンドポイントの 1 つによって初期化された ClientRegistration.Builder