次の方法で共有

OnBehalfOfCredentialBuilder クラス

  • リファレンス
パッケージ:
com.azure.identity
Maven 成果物:
com.azure:azure-identity:1.10.4

public class OnBehalfOfCredentialBuilder
extends AadCredentialBuilderBase<OnBehalfOfCredentialBuilder>

をインスタンス化 OnBehalfOfCredentialするための Fluent 資格情報ビルダー。

Azure での認証の代理は、ユーザーまたはアプリケーションが別の ID プロバイダーからの資格情報を使用してサービスまたはリソースに対して認証を行う方法です。 この種類の認証は、通常、ユーザーまたはアプリケーションが Azure のリソースにアクセスしたいが、資格情報が別の ID プロバイダー (オンプレミスの Active Directoryやサードパーティの ID プロバイダーなど) によって管理されている場合に使用されます。 Azure で "On Behalf of" 認証を使用するには、ユーザーはまず資格情報を使用して ID プロバイダーに対して認証を行う必要があります。 その後、ID プロバイダーは、ユーザーとそのアクセス許可に関する情報を含むセキュリティ トークンを発行します。 その後、このセキュリティ トークンは Azure に渡され、これを使用してユーザーまたはアプリケーションを認証し、要求されたリソースへのアクセス権を付与します。 OnBehalfOfCredential は、ユーザー プリンシパルに代わって、AAD アプリケーションのクライアント シークレット/証明書とユーザー アサーションを使用してトークンを取得します。

次のコード サンプルは、 を使用して OnBehalfOfCredentialBuilder を構成する のOnBehalfOfCredential作成を示しています。 をtenantId作成OnBehalfOfCredentialするには、 パラメーターと clientSecret パラメーターclientIdが必要です。 は userAssertion 、 で OnBehalfOfCredentialBuilder必要に応じて指定できます。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。

TokenCredential onBehalfOfCredential = new OnBehalfOfCredentialBuilder()
     .clientId("<app-client-ID>")
     .clientSecret("<app-Client-Secret>")
     .tenantId("<app-tenant-ID>")
     .userAssertion("<user-assertion>")
     .build();

コンストラクターの概要

コンストラクター 説明
OnBehalfOfCredentialBuilder()

メソッドの概要

修飾子と型 メソッドと説明
OnBehalfOfCredential build()

現在の構成で新しい OnBehalfOfCredential を作成します。
OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

認証用のクライアント証明書のパスワードを AAD に設定します。
OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

認証のクライアント シークレットを設定します。
OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

認証用の PEM 証明書のパスを AAD に設定します。
OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

AAD に認証するための PFX 証明書のパスとパスワードを設定します。
OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

x5c 要求 (証明書の公開キー) を認証要求の一部として送信し、サブジェクト名/発行者ベースの認証を有効にする必要があるかどうかを指定します。
OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

永続的な共有トークン キャッシュ オプションを構成し、既定で無効になっている永続的なトークン キャッシュを有効にします。
OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

認証要求の代理として使用するユーザー アサーション スコープを構成します。

メソッドの継承元: AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

メソッドの継承元: CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

OnBehalfOfCredentialBuilder

public OnBehalfOfCredentialBuilder()

メソッドの詳細

build

public OnBehalfOfCredential build()

現在の構成で新しい OnBehalfOfCredential を作成します。

Returns:

現在 OnBehalfOfCredential の構成を含む 。

clientCertificatePassword

public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

認証用のクライアント証明書のパスワードを AAD に設定します。

Parameters:

clientCertificatePassword - 証明書を保護するパスワード

Returns:

このビルダーの更新されたインスタンス。

clientSecret

public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

認証のクライアント シークレットを設定します。

Parameters:

clientSecret - AAD アプリケーションのシークレット値。

Returns:

このビルダーの更新されたインスタンス。

pemCertificate

public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

認証用の PEM 証明書のパスを AAD に設定します。

Parameters:

pemCertificatePath - 証明書を含む PEM ファイル

Returns:

このビルダーの更新されたインスタンス。

pfxCertificate

public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

AAD に認証するための PFX 証明書のパスとパスワードを設定します。

Parameters:

pfxCertificatePath - 証明書を含むパスワードで保護された PFX ファイル

Returns:

このビルダーの更新されたインスタンス。

sendCertificateChain

public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

x5c 要求 (証明書の公開キー) を認証要求の一部として送信し、サブジェクト名/発行者ベースの認証を有効にする必要があるかどうかを指定します。 既定値は false です。

Parameters:

sendCertificateChain - 認証要求の一部として証明書チェーンを送信する必要があるかどうかを示す フラグ。

Returns:

このビルダーの更新されたインスタンス。

tokenCachePersistenceOptions

public OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

永続的な共有トークン キャッシュ オプションを構成し、既定で無効になっている永続的なトークン キャッシュを有効にします。 構成されている場合、資格情報は、現在のユーザーに対して保護されたコンピューターに永続化されたキャッシュにトークンを格納します。これは、他の資格情報とプロセスで共有できます。

Parameters:

tokenCachePersistenceOptions - トークン キャッシュ構成オプション

Returns:

トークン キャッシュ オプションが構成された、このビルダーの更新されたインスタンス。

userAssertion

public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

OnBehalfOf 認証要求に使用するユーザー アサーション スコープを構成します。

Parameters:

userAssertion - 代理認証フローに使用されるユーザー アサーション アクセス トークン

Returns:

ユーザー アサーション スコープが構成された、このビルダーの更新されたインスタンス。

適用対象