AuthDelegate::OAuth2Challenge Class Reference

a class that contains all the information required from the calling application in order to generate an oauth2 token. More...

#include <common_types.h>

Public Member Functions
	OAuth2Challenge (const std::string &authority, const std::string &resource, const std::string &scope=std::string(), const std::string &claims=std::string())
	Construct a new OAuth2Challenge object.
const std::string &	GetAuthority () const
	Get the authority string.
const std::string &	GetResource () const
	Get the resource string.
const std::string &	GetScope () const
	Get the scope string.
const std::string &	GetClaims () const
	Get the claims string.

Private Attributes
std::string	mAuthority
std::string	mResource
std::string	mScope
std::string	mClaims

Detailed Description

a class that contains all the information required from the calling application in order to generate an oauth2 token.

Constructor & Destructor Documentation

OAuth2Challenge()

AuthDelegate::OAuth2Challenge::OAuth2Challenge ( const std::string & authority, const std::string & resource, const std::string & scope = std::string(), const std::string & claims = std::string() )

inline

Construct a new OAuth2Challenge object.

Parameters

authority	the authority the token needs to be generated against.
resource	the resource the token is set to.
scope	the scope the token is set to.

Member Function Documentation

GetAuthority()

const std::string & AuthDelegate::OAuth2Challenge::GetAuthority ( ) const

inline

Get the authority string.

Returns

the authority string.

GetClaims()

const std::string & AuthDelegate::OAuth2Challenge::GetClaims ( ) const

inline

Get the claims string.

Returns

the claims string.

GetResource()

const std::string & AuthDelegate::OAuth2Challenge::GetResource ( ) const

inline

Get the resource string.

Returns

the resource string.

GetScope()

const std::string & AuthDelegate::OAuth2Challenge::GetScope ( ) const

inline

Get the scope string.

Returns

the scope string.

Member Data Documentation

mAuthority

std::string AuthDelegate::OAuth2Challenge::mAuthority

private

mClaims

std::string AuthDelegate::OAuth2Challenge::mClaims

private

mResource

std::string AuthDelegate::OAuth2Challenge::mResource

private

mScope

std::string AuthDelegate::OAuth2Challenge::mScope

private

---

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

• /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/common_types.h