Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
OnBehalfOfCredential 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:
- 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.TokenCredentialtype OnBehalfOfCredential = class
inherit TokenCredentialPublic Class OnBehalfOfCredential
Inherits TokenCredential- Inheritance
Constructors
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| CreateTokenOptions(IReadOnlyDictionary<String,Object>) |
Creates a new instance of GetTokenOptions using the provided |
| GetToken(GetTokenOptions, CancellationToken) |
Gets an AuthenticationToken for the provided |
| 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 |
| 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
Azure SDK for .NET
Feedback
Was this page helpful?