InteractiveBrowserCredentialBuilder クラス
- java.
lang. Object - com.
azure. identity. CredentialBuilderBase<T> - com.
azure. identity. AadCredentialBuilderBase<T> - com.
azure. identity. InteractiveBrowserCredentialBuilder
- com.
- com.
- com.
public class InteractiveBrowserCredentialBuilder
extends AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>
をインスタンス化 InteractiveBrowserCredentialするための Fluent 資格情報ビルダー。
対話型ブラウザー認証は、ユーザーが Web ブラウザーを使用してアプリケーションとサービスにサインインできるようにする 、Azure Active Directory (Azure AD) によって提供される認証フローの一種です。 この認証方法は、ユーザーが自分の資格情報を Web ページに直接入力する Web アプリケーションでよく使用されます。 対話型ブラウザー認証を使用すると、ユーザーは Web アプリケーションに移動し、ユーザー名とパスワードの資格情報を入力するように求められます。 その後、アプリケーションはユーザーを Azure AD サインイン ページにリダイレクトし、資格情報を再入力するように求められます。 ユーザーが正常に認証されると、Azure AD は、アプリケーションがリソースへのユーザーのアクセスを承認するために使用できるセキュリティ トークンを発行します。 は InteractiveBrowserCredential 、ユーザーを対話形式で認証し、既定のシステム ブラウザーでトークンを取得し、ユーザーが独自の資格情報を使用してアプリケーションを認証できるようにすることで、スムーズな認証エクスペリエンスを提供します。 認証されると、oauth2 フローは応答 URL を介して認証コードの資格情報に通知します。 詳細については、概念に関する 知識と構成の詳細を参照してください。
サンプル: InteractiveBrowserCredential の構築
次のコード サンプルは、 を使用して InteractiveBrowserCredentialBuilder を構成する のInteractiveBrowserCredential作成を示しています。 既定では、資格情報は localhost リダイレクト URL をターゲットにして、その動作を redirectUrl(String redirectUrl) オーバーライドするために、 を必要に応じて指定できます。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。
TokenCredential interactiveBrowserCredential = new InteractiveBrowserCredentialBuilder()
.redirectUrl("http://localhost:8765")
.build();
コンストラクターの概要
| コンストラクター | 説明 | |
|---|---|---|
| InteractiveBrowserCredentialBuilder() | ||
メソッドの概要
メソッドの継承元: AadCredentialBuilderBase
メソッドの継承元: CredentialBuilderBase
メソッドの継承元: java.lang.Object
コンストラクターの詳細
InteractiveBrowserCredentialBuilder
public InteractiveBrowserCredentialBuilder()
メソッドの詳細
additionallyAllowedTenants
public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされているテナントのトークンを資格情報で取得できるようにします。 TenantId に値が指定されていない場合、このオプションは無効になり、資格情報は要求されたテナントのトークンを取得します。
Overrides:
InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)Parameters:
Returns:
additionallyAllowedTenants
public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされているテナントのトークンを資格情報で取得できるようにします。 TenantId に値が指定されていない場合、このオプションは無効になり、資格情報は要求されたテナントのトークンを取得します。
Overrides:
InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)Parameters:
Returns:
authenticationRecord
public InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)
以前の AuthenticationRecord 認証からキャプチャした を設定します。
Parameters:
Returns:
browserCustomizationOptions
public InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)
対話型認証用にブラウザーをカスタマイズするためのオプションを構成します。
Parameters:
Returns:
build
public InteractiveBrowserCredential build()
現在の構成で新しい InteractiveBrowserCredential を作成します。
Returns:
disableAutomaticAuthentication
public InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()
自動認証を無効にし、 がユーザーに InteractiveBrowserCredential 自動的にプロンプトを表示しないようにします。 自動認証が無効 AuthenticationRequiredException になっている場合、ユーザーの操作が必要な場合は から getToken(TokenRequestContext request) がスローされます。 アプリケーションは、この例外を処理し、 または authenticate(TokenRequestContext request) を呼び出authenticate()してユーザーを対話形式で認証する役割を担います。
Returns:
loginHint
public InteractiveBrowserCredentialBuilder loginHint(String loginHint)
ログイン ページのユーザー名/メール アドレス フィールドに入力するユーザー名候補を設定します。 ユーザーは引き続き別のユーザー名でログインできます。
Parameters:
Returns:
port
@Deprecated
public InteractiveBrowserCredentialBuilder port(int port)
非推奨
http://localhost:{port} URL を構成します。
アプリケーションで有効な応答 URL として登録する http://localhost:{port} 必要があるローカル HTTP サーバーのポートを設定します。
Parameters:
Returns:
redirectUrl
public InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)
STS がセキュリティ コードを使用してアプリケーションをコールバックするリダイレクト URL を設定します。 カスタム クライアント ID が を使用して InteractiveBrowserCredentialBuilder#clientId(String) 指定され、アプリケーションの登録時に指定されたリダイレクト URL と一致する必要がある場合に必要です。
Parameters:
Returns:
tokenCachePersistenceOptions
public InteractiveBrowserCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)
永続的な共有トークン キャッシュ オプションを構成し、既定で無効になっている永続的なトークン キャッシュを有効にします。 構成されている場合、資格情報は、現在のユーザーに対して保護されたコンピューターに永続化されたキャッシュにトークンを格納します。これは、他の資格情報とプロセスで共有できます。
Parameters:
Returns: