TokenCredential Class

Protocol for classes able to provide OAuth tokens.

Constructor

TokenCredential(*args, **kwargs)

Methods

get_token

Request an access token for scopes.

get_token

Request an access token for scopes.

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

Parameters

Name	Description
scopes Required	str The type of access needed.

Keyword-Only Parameters

Name	Description
claims	str Additional claims required in the token, such as those returned in a resource provider's claims challenge following an authorization failure. Default value: None
tenant_id	str Optional tenant to include in the token request. Default value: None
enable_cae	bool Indicates whether to enable Continuous Access Evaluation (CAE) for the requested token. Defaults to False. Default value: False

Returns

Type	Description
AccessToken	An AccessToken instance containing the token string and its expiration time in Unix time.