Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
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>

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.
 

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
authoritythe authority the token needs to be generated against.
resourcethe resource the token is set to.
scopethe scope the token is set to.

Definition at line 337 of file common_types.h.

342 : mAuthority(authority),
343 mResource(resource),
344 mScope(scope),
345 mClaims(claims) {
346 }

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.

352{ return 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.

370{ return 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.

358{ return 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.

364{ return mScope; }

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