Interface for OAuth 2.0 credentials used to access Google Cloud services. More...

#include <google/cloud/storage/oauth2/credentials.h>

Public Member Functions
virtual	~Credentials ()=default

virtual StatusOr< std::string >	AuthorizationHeader ()=0
	Attempts to obtain a value for the Authorization HTTP header. More...

virtual StatusOr< std::vector< std::uint8_t > >	SignBlob (SigningAccount const &service_account, std::string const &string_to_sign) const
	Try to sign `string_to_sign` using `service_account`. More...

virtual std::string	AccountEmail () const
	Return the account's email associated with these credentials, if any. More...

virtual std::string	KeyId () const
	Return the account's key_id associated with these credentials, if any. More...

Detailed Description

Interface for OAuth 2.0 credentials used to access Google Cloud services.

Instantiating a specific kind of Credentials should usually be done via the convenience methods declared in google_credentials.h.

See also: https://cloud.google.com/docs/authentication/ for an overview of authenticating to Google Cloud Platform APIs.

Deprecated:: Prefer using the unified credentials documented in Authentication Components

Constructor & Destructor Documentation

◆ ~Credentials()

virtual google::cloud::storage::oauth2::Credentials::~Credentials ( )

virtualdefault

Member Function Documentation

◆ AccountEmail()

virtual std::string google::cloud::storage::oauth2::Credentials::AccountEmail ( ) const

inlinevirtual

Return the account's email associated with these credentials, if any.

Deprecated:: Prefer using the unified credentials documented in Authentication Components

Reimplemented in google::cloud::storage::oauth2::ComputeEngineCredentials< HttpRequestBuilderType, ClockType >, and google::cloud::storage::oauth2::ServiceAccountCredentials< HttpRequestBuilderType, ClockType >.

◆ AuthorizationHeader()

virtual StatusOr< std::string > google::cloud::storage::oauth2::Credentials::AuthorizationHeader ( )

pure virtual

Attempts to obtain a value for the Authorization HTTP header.

If unable to obtain a value for the Authorization header, which could happen for Credentials that need to be periodically refreshed, the underlying Status will indicate failure details from the refresh HTTP request. Otherwise, the returned value will contain the Authorization header to be used in HTTP requests.

Deprecated:: Prefer using the unified credentials documented in Authentication Components

Implemented in google::cloud::storage::oauth2::AnonymousCredentials, google::cloud::storage::oauth2::AuthorizedUserCredentials< HttpRequestBuilderType, ClockType >, google::cloud::storage::oauth2::ComputeEngineCredentials< HttpRequestBuilderType, ClockType >, and google::cloud::storage::oauth2::ServiceAccountCredentials< HttpRequestBuilderType, ClockType >.

◆ KeyId()

virtual std::string google::cloud::storage::oauth2::Credentials::KeyId ( ) const

inlinevirtual

Return the account's key_id associated with these credentials, if any.

Deprecated:: Prefer using the unified credentials documented in Authentication Components

Reimplemented in google::cloud::storage::oauth2::ServiceAccountCredentials< HttpRequestBuilderType, ClockType >.

◆ SignBlob()

virtual StatusOr< std::vector< std::uint8_t > > google::cloud::storage::oauth2::Credentials::SignBlob	(	SigningAccount const &	service_account,
		std::string const &	string_to_sign
	)		const

virtual

Try to sign string_to_sign using service_account.

Some Credentials types can locally sign a blob, most often just on behalf of an specific service account. This function returns an error if the credentials cannot sign the blob at all, or if the service account is a mismatch.

Deprecated:: Prefer using the unified credentials documented in Authentication Components