Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ClientAssertionCredential Class

Definition

Namespace:
Azure.Identity
Assemblies:
Azure.Core.dll, Azure.Identity.dll
Assembly:
Azure.Identity.dll
Packages:
Azure.Core v1.58.0, Azure.Identity v1.17.2
Package:
Azure.Identity v1.18.0-beta.3
Source:
ClientAssertionCredential.cs
Source:
ClientAssertionCredential.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enables authentication of a Microsoft Entra service principal using a signed client assertion.

public class ClientAssertionCredential : Azure.Core.TokenCredential
type ClientAssertionCredential = class
 inherit TokenCredential
Public Class ClientAssertionCredential
Inherits TokenCredential
Inheritance

Constructors

Name Description
ClientAssertionCredential()

Protected constructor for mocking.

ClientAssertionCredential(String, String, Func<CancellationToken,Task<String>>, ClientAssertionCredentialOptions)

Creates an instance of the ClientAssertionCredential with an asynchronous callback that provides a signed client assertion to authenticate against Microsoft Entra ID.

ClientAssertionCredential(String, String, Func<String>, ClientAssertionCredentialOptions)

Creates an instance of the ClientAssertionCredential with a synchronous callback that provides a signed client assertion to authenticate against Microsoft Entra ID.

Methods

Name Description
CreateTokenOptions(IReadOnlyDictionary<String,Object>)

Creates a new instance of GetTokenOptions using the provided properties.

(Inherited from TokenCredential)
GetToken(GetTokenOptions, CancellationToken)

Gets an AuthenticationToken for the provided properties.

(Inherited from TokenCredential)
GetToken(TokenRequestContext, CancellationToken)

Obtains a token from Microsoft Entra ID, by calling the assertionCallback specified when constructing the credential to obtain a client assertion for authentication.

GetTokenAsync(GetTokenOptions, CancellationToken)

Gets an AuthenticationToken for the provided properties.

(Inherited from TokenCredential)
GetTokenAsync(TokenRequestContext, CancellationToken)

Obtains a token from Microsoft Entra ID, by calling the assertionCallback specified when constructing the credential to obtain a client assertion for authentication.

Applies to


Feedback

Was this page helpful?