SharedTokenCacheCredential Class

Authenticates using tokens in the local cache shared between Microsoft applications.

Inheritance

builtins.object

SharedTokenCacheCredential

Constructor

SharedTokenCacheCredential(username: Optional[str] = None, **kwargs: Any)

Parameters

username

str

default value: None

Username (typically an email address) of the user to authenticate as. This is used when the local cache contains tokens for multiple identities.

authority

str

Authority of an Azure Active Directory endpoint, for example 'login.microsoftonline.com', the authority for Azure Public Cloud (which is the default). AzureAuthorityHosts defines authorities for other clouds.

tenant_id

str

an Azure Active Directory tenant ID. Used to select an account when the cache contains tokens for multiple identities.

authentication_record

AuthenticationRecord

an authentication record returned by a user credential such as DeviceCodeCredential or InteractiveBrowserCredential

cache_persistence_options

TokenCachePersistenceOptions

configuration for persistent token caching. If not provided, the credential will use the persistent cache shared by Microsoft development applications

Methods

close	Close the credential's transport session.
get_token	Get an access token for scopes from the shared cache. If no access token is cached, attempt to acquire one using a cached refresh token. This method is called automatically by Azure SDK clients.
supported	Whether the shared token cache is supported on the current platform.

close

Close the credential's transport session.

close() -> None

get_token

Get an access token for scopes from the shared cache.

If no access token is cached, attempt to acquire one using a cached refresh token.

This method is called automatically by Azure SDK clients.

get_token(*scopes, **kwargs)

Parameters

scopes

str

Required

desired scopes for the access token. This method requires at least one scope.

claims

str

additional claims required in the token, such as those returned in a resource provider's claims challenge following an authorization failure

Return type

AccessToken

Exceptions

CredentialUnavailableError

the cache is unavailable or contains insufficient user information

ClientAuthenticationError

authentication failed. The error's message attribute gives a reason.

supported

Whether the shared token cache is supported on the current platform.

static supported() -> bool

Return type

bool