Azure::Identity::ClientSecretCredential Class Reference

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

tenantId	Tenant ID.
clientId	Client ID.
clientSecret	Client secret.
options	Options 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

tenantId	Tenant ID.
clientId	Client ID.
clientSecret	Client Secret.
options	Options 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

tokenRequestContext	A context to get the token in.
context	A context to control the request lifetime.

Returns

Authentication token.

Exceptions

Azure::Core::Credentials::AuthenticationException

Authentication error occurred.

---

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

• inc/azure/identity/client_secret_credential.hpp
• src/client_secret_credential.cpp