Partager via

TokenCredential Class

  • Reference

Protocol for classes able to provide OAuth tokens.

Inheritance
typing_extensions.Protocol
TokenCredential

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.
tenant_id
str

Optional tenant to include in the token request.
enable_cae
bool

Indicates whether to enable Continuous Access Evaluation (CAE) for the requested token. Defaults to False.

Returns

Type Description
AccessToken

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