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 <src/api/mip/common_types.h>

Collaboration diagram for AuthDelegate::OAuth2Challenge:

Public Member Functions
const std::string &	GetAuthority () const
	Get the authority string.
const std::string &	GetClaims () const
	Get the claims string.
const std::string &	GetResource () const
	Get the resource string.
const std::string &	GetScope () const
	Get the scope string.
	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.

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

Detailed Description

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

Definition at line 328 of file common_types.h.

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.

Definition at line 337 of file common_types.h.

        : mAuthority(authority),
          mResource(resource),
          mScope(scope),
          mClaims(claims) {
    }

Member Function Documentation

GetAuthority()

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

inline

Get the authority string.

Returns

the authority string.

Definition at line 352 of file common_types.h.

{ return mAuthority; }

References mAuthority.

GetClaims()

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

inline

Get the claims string.

Returns

the claims string.

Definition at line 370 of file common_types.h.

{ return mClaims; }

References mClaims.

GetResource()

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

inline

Get the resource string.

Returns

the resource string.

Definition at line 358 of file common_types.h.

{ return mResource; }

References mResource.

GetScope()

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

inline

Get the scope string.

Returns

the scope string.

Definition at line 364 of file common_types.h.

{ return mScope; }

References mScope.

Member Data Documentation

mAuthority

std::string AuthDelegate::OAuth2Challenge::mAuthority

private

Definition at line 372 of file common_types.h.

Referenced by GetAuthority().

mClaims

std::string AuthDelegate::OAuth2Challenge::mClaims

private

Definition at line 375 of file common_types.h.

Referenced by GetClaims().

mResource

std::string AuthDelegate::OAuth2Challenge::mResource

private

Definition at line 373 of file common_types.h.

Referenced by GetResource().

mScope

std::string AuthDelegate::OAuth2Challenge::mScope

private

Definition at line 374 of file common_types.h.

Referenced by GetScope().

---

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

• src/api/mip/common_types.h