AuthorizationCodeCredential クラス

Azure Active Directory から以前に取得した承認コードを使用して認証します。

認証フローの詳細については、 Azure Active Directory のドキュメントを参照してください 。

継承

azure.identity._internal.get_token_mixin.GetTokenMixin

AuthorizationCodeCredential

コンストラクター

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)

パラメーター

tenant_id

str

必須

アプリケーションの Azure Active Directory テナントの ID。 "ディレクトリ" ID とも呼ばれます。

client_id

str

必須

アプリケーションのクライアント ID

authorization_code

str

必須

ユーザーのログインからの承認コード

redirect_uri

str

必須

アプリケーションのリダイレクト URI。 承認コードを要求するために使用される URI と一致する必要があります。

authority

str

Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など)、Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。

client_secret

str

アプリケーションのクライアント シークレットの 1 つ。 Web アプリと Web API にのみ必要です。

additionally_allowed_tenants

List[str]

資格情報がトークンを取得できる指定した "tenant_id" に加えて、テナントを指定します。 ワイルドカード値 "*" を追加して、資格情報がアプリケーションがアクセスできる任意のテナントのトークンを取得できるようにします。

例

AuthorizationCodeCredential を作成します。

   from azure.identity import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

メソッド

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

必須

アクセス トークンの目的のスコープ。 このメソッドには、少なくとも 1 つのスコープが必要です。 スコープの詳細については、「」を参照してください https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc。

claims

str

承認エラーの後にリソース プロバイダーの要求チャレンジで返される要求など、トークンに必要な追加の要求。

tenant_id

str

トークン要求に含めるオプションのテナント。

戻り値

目的のスコープを持つアクセス トークン。

の戻り値の型 :

AccessToken

例外

ClientAuthenticationError

認証に失敗しました。 エラーの message 属性には理由があります。 Azure Active Directory からのエラー応答は、エラーの response 属性として使用できます。