olp::authentication::AuthorizeResult Class Reference

Represents the policy decision for a given request context against the HERE Service. More...

#include <AuthorizeResult.h>

Public Member Functions
const DecisionType &	GetDecision () const
	Gets the overall policy decision. More...
void	SetDecision (DecisionType decision)
	Sets the overall policy decision. More...
const std::string &	GetClientId () const
	Gets the client ID. More...
void	SetClientId (std::string client_id)
	Sets the client ID. More...
const std::vector< ActionResult > &	GetActionResults () const
	Gets the list of results for each action. More...
void	SetActionResults (std::vector< ActionResult > actions)
	Sets the list of results for each action. More...

Detailed Description

Represents the policy decision for a given request context against the HERE Service.

Collects all permissions associated with the authenticated user or application, requested service ID, and requested contract ID. For each action-resource pair in the request, this class determines an individual policy decision: DENY or ALLOW.

Member Function Documentation

GetActionResults()

const std::vector<ActionResult>& olp::authentication::AuthorizeResult::GetActionResults ( ) const

inline

Gets the list of results for each action.

Note

The data is present only if the diagnostics flag is true for DecisionRequest.

Returns

The list of action results.

GetClientId()

const std::string& olp::authentication::AuthorizeResult::GetClientId ( ) const

inline

Gets the client ID.

Returns

The client ID.

GetDecision()

const DecisionType& olp::authentication::AuthorizeResult::GetDecision ( ) const

inline

Gets the overall policy decision.

See also

DecisionOperatorType for more information.

Returns

The decision based on the operator type.

SetActionResults()

void olp::authentication::AuthorizeResult::SetActionResults ( std::vector< ActionResult >  actions )

inline

Sets the list of results for each action.

Parameters

actions

The vector of ActionResult.

SetClientId()

void olp::authentication::AuthorizeResult::SetClientId ( std::string  client_id )

inline

Sets the client ID.

Parameters

client_id

The client ID.

SetDecision()

void olp::authentication::AuthorizeResult::SetDecision ( DecisionType  decision )

inline

Sets the overall policy decision.

Parameters

decision

The policy decision.

---

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

• olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeResult.h