OnBehalfOfCredential Class

  • Reference

Definition

Namespace:
Azure.Identity
Assembly:
Azure.Identity.dll
Package:
Azure.Identity v1.13.1
Package:
Azure.Identity v1.13.0-beta.2
Source:
OnBehalfOfCredential.cs
Source:
OnBehalfOfCredential.cs

Enables authentication to Microsoft Entra ID using an On-Behalf-Of flow.

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

Constructors

OnBehalfOfCredential()

Protected constructor for mocking.
OnBehalfOfCredential(String, String, Func<CancellationToken,Task<String>>, String, OnBehalfOfCredentialOptions)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion.
OnBehalfOfCredential(String, String, Func<String>, String, OnBehalfOfCredentialOptions)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion.
OnBehalfOfCredential(String, String, String, String, OnBehalfOfCredentialOptions)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID.
OnBehalfOfCredential(String, String, String, String)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID.
OnBehalfOfCredential(String, String, X509Certificate2, String, OnBehalfOfCredentialOptions)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
OnBehalfOfCredential(String, String, X509Certificate2, String)

Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.

Methods

GetToken(TokenRequestContext, CancellationToken)

Authenticates with Microsoft Entra ID and returns an access token if successful. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances to optimize cache effectiveness.
GetTokenAsync(TokenRequestContext, CancellationToken)

Authenticates with Microsoft Entra ID and returns an access token if successful. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances to optimize cache effectiveness.

Applies to