azure-identity
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Azure::Identity::ClientSecretCredential Class Referencefinal

Client Secret Credential authenticates with the Azure services using a Tenant ID, Client ID and a client secret. More...

#include <client_secret_credential.hpp>

Inheritance diagram for Azure::Identity::ClientSecretCredential:

Public Member Functions

 ClientSecretCredential (std::string tenantId, std::string const &clientId, std::string const &clientSecret, ClientSecretCredentialOptions const &options)
 Constructs a Client Secret Credential.
 
 ClientSecretCredential (std::string tenantId, std::string const &clientId, std::string const &clientSecret, Core::Credentials::TokenCredentialOptions const &options=Core::Credentials::TokenCredentialOptions())
 Constructs a Client Secret Credential.
 
 ~ClientSecretCredential () override
 Destructs ClientSecretCredential.
 
Core::Credentials::AccessToken GetToken (Core::Credentials::TokenRequestContext const &tokenRequestContext, Core::Context const &context) const override
 Gets an authentication token.
 

Detailed Description

Constructor & Destructor Documentation

◆ ClientSecretCredential() [1/2]

ClientSecretCredential::ClientSecretCredential ( std::string  tenantId,
std::string const &  clientId,
std::string const &  clientSecret,
ClientSecretCredentialOptions const &  options 
)
explicit
Parameters
tenantIdTenant ID.
clientIdClient ID.
clientSecretClient secret.
optionsOptions for token retrieval.

◆ ClientSecretCredential() [2/2]

ClientSecretCredential::ClientSecretCredential ( std::string  tenantId,
std::string const &  clientId,
std::string const &  clientSecret,
Core::Credentials::TokenCredentialOptions const &  options = Core::Credentials::TokenCredentialOptions() 
)
explicit
Parameters
tenantIdTenant ID.
clientIdClient ID.
clientSecretClient Secret.
optionsOptions for token retrieval.

◆ ~ClientSecretCredential()

ClientSecretCredential::~ClientSecretCredential ( )
overridedefault

Member Function Documentation

◆ GetToken()

AccessToken ClientSecretCredential::GetToken ( Core::Credentials::TokenRequestContext const &  tokenRequestContext,
Core::Context const &  context 
) const
override
Parameters
tokenRequestContextA context to get the token in.
contextA context to control the request lifetime.
Returns
Authentication token.
Exceptions
Azure::Core::Credentials::AuthenticationExceptionAuthentication error occurred.

The documentation for this class was generated from the following files: