ClientSecretCredential Class

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.14.1

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

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.TokenCredential

type ClientSecretCredential = class
    inherit TokenCredential

Public Class ClientSecretCredential
Inherits TokenCredential

Inheritance: Object

AuthenticationTokenProvider

TokenCredential
ClientSecretCredential

Constructors

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

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, 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 `properties`. (Inherited from TokenCredential)
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