OnBehalfOfCredential Class

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.14.2

Package:: Azure.Identity v1.14.0-beta.4

Source:: OnBehalfOfCredential.cs

Source:: OnBehalfOfCredential.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 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

AuthenticationTokenProvider

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

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)	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(GetTokenOptions, CancellationToken)	Gets an AuthenticationToken for the provided `properties`. (Inherited from TokenCredential)
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