Azure::Identity::ClientCertificateCredential Class Reference

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

#include <client_certificate_credential.hpp>

Inheritance diagram for Azure::Identity::ClientCertificateCredential:

Public Member Functions
	ClientCertificateCredential (std::string tenantId, std::string const &clientId, std::string const &clientCertificatePath, Core::Credentials::TokenCredentialOptions const &options=Core::Credentials::TokenCredentialOptions())
	Constructs a Client Certificate Credential.
	ClientCertificateCredential (std::string tenantId, std::string const &clientId, std::string const &clientCertificate, std::string const &privateKey, ClientCertificateCredentialOptions const &options={})
	Constructs a Client Certificate Credential.
	ClientCertificateCredential (std::string tenantId, std::string const &clientId, std::string const &clientCertificatePath, ClientCertificateCredentialOptions const &options)
	Constructs a Client Certificate Credential.
	~ClientCertificateCredential () override
	Destructs ClientCertificateCredential.
Core::Credentials::AccessToken	GetToken (Core::Credentials::TokenRequestContext const &tokenRequestContext, Core::Context const &context) const override
	Gets an authentication token.

Detailed Description

Constructor & Destructor Documentation

ClientCertificateCredential() [1/3]

ClientCertificateCredential::ClientCertificateCredential ( std::string  tenantId, std::string const &  clientId, std::string const &  clientCertificatePath, Core::Credentials::TokenCredentialOptions const &  options = Core::Credentials::TokenCredentialOptions()  )

explicit

Parameters

tenantId	Tenant ID.
clientId	Client ID.
clientCertificatePath	The path to a PEM file containing exactly one certificate which is used for signing along with its corresponding private key.
options	Options for token retrieval.

ClientCertificateCredential() [2/3]

ClientCertificateCredential::ClientCertificateCredential ( std::string  tenantId, std::string const &  clientId, std::string const &  clientCertificate, std::string const &  privateKey, ClientCertificateCredentialOptions const &  options = {}  )

explicit

Parameters

tenantId	Tenant ID.
clientId	Client ID.
clientCertificate	The PEM encoded x509 certificate which is used for signing, in base64 string format, including the begin and end headers.
privateKey	The PEM encoded representation of the corresponding RSA private key of the certificate.
options	Options for token retrieval.

ClientCertificateCredential() [3/3]

ClientCertificateCredential::ClientCertificateCredential ( std::string  tenantId, std::string const &  clientId, std::string const &  clientCertificatePath, ClientCertificateCredentialOptions const &  options  )

explicit

Parameters

tenantId	Tenant ID.
clientId	Client ID.
clientCertificatePath	The path to a PEM file containing exactly one certificate which is used for signing along with its corresponding private key.
options	Options for token retrieval.

~ClientCertificateCredential()

ClientCertificateCredential::~ClientCertificateCredential ( )

overridedefault

Member Function Documentation

GetToken()

AccessToken ClientCertificateCredential::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.

Exceptions

Azure::Core::Credentials::AuthenticationException

Authentication error occurred.

---

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

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