InteractiveBrowserCredential クラス
ブラウザーを開き、ユーザーを対話形式で認証します。
get_token Azure Active Directory によって提供されるログイン URL に対するブラウザーを開き、PKCE (Proof Key for Code Exchange) を内部的に使用して認証コード フローを使用してそこでユーザーを認証します。
- 継承
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
コンストラクター
InteractiveBrowserCredential(**kwargs: Any)
パラメーター
- authority
- str
Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など)、Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。
- tenant_id
- str
Azure Active Directory テナント ID。 既定では、職場または学校アカウントを認証できる "組織" テナントが使用されます。
- client_id
- str
ユーザーがサインインする Azure Active Directory アプリケーションのクライアント ID。 指定されていない場合、ユーザーは Azure 開発アプリケーションに対して認証を行います。
- login_hint
- str
ログイン ページのユーザー名/メール アドレス フィールドに事前入力するためのユーザー名の提案。 ユーザーは別のユーザー名でログインできます。
- redirect_uri
- str
Azure Active Directory で構成されている client_id によって識別されるアプリケーションのリダイレクト URI ("" などhttp://localhost:8400)。 これは、 client_idの値を渡す場合にのみ必要であり、アプリケーションの登録でリダイレクト URI と一致する必要があります。 資格情報は、ソケットをこの URI にバインドできる必要があります。
- authentication_record
- AuthenticationRecord
AuthenticationRecord によって返される authenticate
- disable_automatic_authentication
- bool
True の場合、 は、 get_token トークンを取得するためにユーザーの操作が必要な場合に発生 AuthenticationRequiredError します。 既定値は False です。
- cache_persistence_options
- TokenCachePersistenceOptions
永続的なトークン キャッシュの構成。 指定しない場合、資格情報はメモリ内のトークンをキャッシュします。
- timeout
- int
ユーザーが認証を完了するまで待機する秒数。 既定値は 300 (5 分) です。
- disable_instance_discovery
- bool
認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを true に設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。 これを True に設定すると、権限の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
例
InteractiveBrowserCredential を作成します。
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
メソッド
authenticate |
ユーザーを対話的に認証します。 |
close | |
get_token |
スコープのアクセス トークンを要求 します。 このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。 |
authenticate
ユーザーを対話的に認証します。
authenticate(**kwargs: Any) -> AuthenticationRecord
パラメーター
によって提供 scopesされるものなど、認証時に要求するスコープ。 指定された場合、認証が成功すると、これらのスコープのアクセス トークンがキャッシュされます。
の戻り値の型 :
例外
認証に失敗しました。 エラーの 属性には message
理由があります。
close
get_token
スコープのアクセス トークンを要求 します。
このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
パラメーター
- scopes
- str
アクセス トークンの目的のスコープ。 このメソッドには、少なくとも 1 つのスコープが必要です。 スコープの詳細については、「」を参照してください https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc。
- claims
- str
承認エラーの後にリソース プロバイダーの要求チャレンジで返される要求など、トークンに必要な追加の要求
- tenant_id
- str
トークン要求に含める省略可能なテナント。
- enable_cae
- bool
は、要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。 既定値は False です。
戻り値
目的のスコープを持つアクセス トークン。
の戻り値の型 :
例外
資格情報に必要なデータ、状態、またはプラットフォームのサポートがないため、認証を試みることができません
認証に失敗しました。 エラーの 属性には message
理由があります。
トークンを取得するにはユーザーの操作が必要であり、このを自動的に開始しないように資格情報が構成されます。 Call (英語の可能性あり)
対話型認証を開始します。