UsernamePasswordCredential 類別

  • 參考

以使用者名稱和密碼來驗證使用者。

一般而言，Microsoft 不建議使用這種驗證，因為它比其他驗證流程更安全。

使用此認證的驗證不是互動式的，因此 與任何形式的多重要素驗證或同意提示不相容。 應用程式必須已經同意使用者或目錄管理員。

此認證只能驗證公司與學校帳戶;不支援 Microsoft 帳戶。 如需帳戶類型的詳細資訊，請參閱 Azure Active Directory 檔 。

繼承
azure.identity._internal.interactive.InteractiveCredential
UsernamePasswordCredential

建構函式

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

參數

client_id
str
必要

應用程式的用戶端識別碼

username
str
必要

使用者的使用者名稱 (通常是電子郵件地址)

password
str
必要

使用者的密碼

authority
str

Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，Azure 公用雲端的授權單位 (，這是預設) 。 AzureAuthorityHosts 定義其他雲端的授權單位。

tenant_id
str

租使用者識別碼或與租使用者相關聯的網域。 如果未提供，預設為「組織」租使用者，僅支援 Azure Active Directory 公司或學校帳戶。

cache_persistence_options
TokenCachePersistenceOptions

永續性權杖快取的組態。 如果未指定，認證將會快取記憶體中的權杖。

disable_instance_discovery
bool

判斷嘗試驗證時是否執行實例探索。 將此設定為 true 將會完全停用實例探索和授權單位驗證。 這項功能適用于無法連線到中繼資料端點的情況，例如私人雲端或 Azure Stack。 實例探索的程式需要從 https://login.microsoft.com/ 中擷取授權單位中繼資料，以驗證授權單位。 藉由將此設定為 True，授權單位的驗證會停用。 因此，請務必確保已設定的授權主機有效且值得信任。

additionally_allowed_tenants
List[str]

除了認證可能取得權杖的指定「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
Iterable[str]

在驗證期間要求的範圍，例如 所提供的 scopes 範圍。 如果提供，成功的驗證將會快取這些範圍的存取權杖。

claims
str

權杖中所需的其他宣告，例如 所提供的宣告 claims

傳回類型

AuthenticationRecord

例外狀況

ClientAuthenticationError

驗證失敗。 錯誤的 message 屬性會提供原因。

close 

close() -> None

例外狀況

ClientAuthenticationError

驗證失敗。 錯誤的 message 屬性會提供原因。

get_token

要求 範圍的存取權杖。

Azure SDK 用戶端會自動呼叫此方法。

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

參數

scopes
str
必要

存取權杖所需的範圍。 這個方法至少需要一個範圍。 如需範圍的詳細資訊，請參閱 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc 。

claims
str

權杖中所需的其他宣告，例如在授權失敗之後，在資源提供者的宣告挑戰中傳回的其他宣告

tenant_id
str

要包含在權杖要求中的選擇性租使用者。

enable_cae
bool

指出是否為要求的權杖啟用持續存取評估 (CAE) 。 預設為 False。

傳回

具有所需範圍的存取權杖。

傳回類型

AccessToken

例外狀況

CredentialUnavailableError

認證無法嘗試驗證，因為它缺少必要的資料、狀態或平臺支援

ClientAuthenticationError

驗證失敗。 錯誤的 message 屬性會提供原因。

AuthenticationRequiredError

需要使用者互動才能取得權杖，且認證設定為不會自動開始此動作。 呼叫

authenticate

以開始互動式驗證。