ClientAssertionCredential 類別

  • 參考

使用 JWT 判斷提示驗證服務主體。

此認證適用于進階案例。 CertificateCredential 對於最常見的判斷提示案例，使用憑證驗證服務主體，具有更方便的 API。

繼承
azure.identity._internal.get_token_mixin.GetTokenMixin
ClientAssertionCredential

建構函式

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

參數

tenant_id
str
必要

主體租使用者的識別碼。 也稱為其 「目錄」識別碼。

client_id
str
必要

主體的用戶端識別碼

func
必要

可呼叫的 ，傳回字串判斷提示。 每次取得新的權杖時，認證都會呼叫此認證。

authority
str

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

additionally_allowed_tenants
List[str]

除了認證可能取得權杖的指定「tenant_id」之外，指定租使用者。 新增萬用字元值 「*」，以允許認證取得應用程式可存取之任何租使用者的權杖。

範例

建立 ClientAssertionCredential。


   from azure.identity import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

方法

close
get_token

要求 範圍的存取權杖。

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

close 

close() -> None

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 屬性會提供原因。