SharedTokenCacheCredential クラス

Microsoft アプリケーション間で共有されるローカル キャッシュ内のトークンを使用して認証を行います。

継承

builtins.object

SharedTokenCacheCredential

コンストラクター

SharedTokenCacheCredential(username: str | None = None, **kwargs: Any)

パラメーター

username

str

既定値: None

認証するユーザーのユーザー名 (通常は電子メール アドレス)。 これは、ローカル キャッシュに複数の ID のトークンが含まれている場合に使用されます。

authority

str

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

tenant_id

str

Azure Active Directory テナント ID。 キャッシュに複数の ID のトークンが含まれている場合にアカウントを選択するために使用されます。

authentication_record

AuthenticationRecord

や などの DeviceCodeCredential ユーザー資格情報によって返される認証レコード InteractiveBrowserCredential

cache_persistence_options

TokenCachePersistenceOptions

永続的なトークン キャッシュの構成。 指定しない場合、資格情報は Microsoft 開発アプリケーションによって共有される永続キャッシュを使用します

メソッド

close	資格情報のトランスポート セッションを閉じます。
get_token	共有キャッシュから スコープの アクセス トークンを取得します。 キャッシュされたアクセス トークンがない場合は、キャッシュされた更新トークンを使用してアクセス トークンの取得を試みます。 このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。
supported	共有トークン キャッシュが現在のプラットフォームでサポートされているかどうか。

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

この資格情報では使用されません。指定された値は無視されます。

enable_cae

bool

は、要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。 既定値は False です。

戻り値

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

の戻り値の型 :

AccessToken

例外

CredentialUnavailableError

キャッシュが使用できないか、ユーザー情報が不足しています

ClientAuthenticationError

認証に失敗しました。 エラーの message 属性には理由があります。

supported

共有トークン キャッシュが現在のプラットフォームでサポートされているかどうか。

static supported() -> bool

戻り値

現在のプラットフォームで共有トークン キャッシュがサポートされている場合は True、それ以外の場合は False。

の戻り値の型 :

bool