UsernamePasswordCredential クラス
ユーザー名とパスワードを使用してユーザーを認証します。
一般に、この種の認証は、他の認証フローよりも安全性が低いため、Microsoft はお勧めしません。
この資格情報を使用した認証は対話型ではありません。そのため、 多要素認証や同意のプロンプトの形式と互換性がありません。 アプリケーションは、ユーザーまたはディレクトリ管理者からの同意を既に持っている必要があります。
この資格情報は、職場と学校のアカウントのみを認証できます。Microsoft アカウントはサポートされていません。 アカウントの種類の詳細については、 Azure Active Directory のドキュメントを参照してください 。
- 継承
-
azure.identity._internal.interactive.InteractiveCredentialUsernamePasswordCredential
コンストラクター
UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)パラメーター
- authority
- str
Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など)、Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。
- tenant_id
- str
テナント ID またはテナントに関連付けられているドメイン。 指定しない場合、既定では "organizations" テナントが使用されます。このテナントでは、Azure Active Directory の職場または学校アカウントのみがサポートされます。
- cache_persistence_options
- TokenCachePersistenceOptions
永続的なトークン キャッシュの構成。 指定しない場合、資格情報はトークンをメモリにキャッシュします。
- disable_instance_discovery
- bool
認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを true に設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。 これを True に設定すると、機関の検証は無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
資格情報がトークンを取得できる指定した "tenant_id" に加えて、テナントを指定します。 ワイルドカード値 "*" を追加して、資格情報がアプリケーションがアクセスできる任意のテナントのトークンを取得できるようにします。
例
UsernamePasswordCredential を作成します。
from azure.identity import UsernamePasswordCredential
credential = UsernamePasswordCredential(
client_id="<client_id>",
username="<username>",
password="<password>",
)
メソッド
| 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 (英語の可能性あり)
を使用して対話型認証を開始します。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示