Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ClientSecretCredential 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:
- ClientSecretCredential.cs
- Source:
- ClientSecretCredential.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 a client secret that was generated for an App Registration. More information on how to configure a client secret can be found at https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application.
public class ClientSecretCredential : Azure.Core.TokenCredentialtype ClientSecretCredential = class
inherit TokenCredentialPublic Class ClientSecretCredential
Inherits TokenCredential- Inheritance
Constructors
| Name | Description |
|---|---|
| ClientSecretCredential() |
Protected constructor for mocking. |
| ClientSecretCredential(String, String, String, ClientSecretCredentialOptions) |
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret. |
| ClientSecretCredential(String, String, String, TokenCredentialOptions) |
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret. |
| ClientSecretCredential(String, String, String) |
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret. |
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) |
Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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) |
Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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?