10Duke Scale C++ Client
Loading...
Searching...
No Matches
tenduke::oidc::device::OIDCDeviceFlow Class Referenceabstract

#include <OIDCDeviceFlow.h>

Detailed Description

OpenID Connect -client for OAuth Device Authorization Grant.

(RFC 8628).

This is low-level client, which adds OIDC-logic on top of OAuth Device Authorization Grant. For example of higher level client, see tenduke::oidc::device::OIDCDeviceFlowLogin and its implementation.

Inheritance diagram for tenduke::oidc::device::OIDCDeviceFlow:
tenduke::oidc::OIDCClient tenduke::oidc::device::DefaultOIDCDeviceFlow tenduke::test::mocks::OIDCDeviceFlowMock

Public Member Functions

virtual std::unique_ptr< tenduke::oidc::device::OIDCDeviceAuthenticationRequestauthenticate (const std::string &scopes) const =0
 Creates OIDCRequest which performs the OIDC-authentication.
 
virtual std::unique_ptr< tenduke::oidc::device::OIDCDeviceAuthenticationRequestauthenticate (const std::string &scopes, const std::map< std::string, std::string > &additionalProperties) const =0
 Creates OIDCRequest which performs the OIDC-authentication.
 
- Public Member Functions inherited from tenduke::oidc::OIDCClient
virtual std::unique_ptr< const tenduke::oidc::OIDCRefreshRequestrefresh (const std::shared_ptr< tenduke::oidc::OIDCState > &state) const =0
 Refreshes the OIDC state.
 
virtual std::string requestUserinfo (const std::string &accessToken) const =0
 Requests user information from "userinfo"-endpoint.
 

Member Function Documentation

◆ authenticate() [1/2]

virtual std::unique_ptr< tenduke::oidc::device::OIDCDeviceAuthenticationRequest > tenduke::oidc::device::OIDCDeviceFlow::authenticate ( const std::string &  scopes) const
pure virtual

Creates OIDCRequest which performs the OIDC-authentication.

Parameters
scopesscopes to authenticate / authorize
Returns
the request

Implemented in tenduke::oidc::device::DefaultOIDCDeviceFlow.

◆ authenticate() [2/2]

virtual std::unique_ptr< tenduke::oidc::device::OIDCDeviceAuthenticationRequest > tenduke::oidc::device::OIDCDeviceFlow::authenticate ( const std::string &  scopes,
const std::map< std::string, std::string > &  additionalProperties 
) const
pure virtual

Creates OIDCRequest which performs the OIDC-authentication.

Parameters
scopesscopes to authenticate / authorize
additionalPropertiesadditional properties added to the request
Returns
the request

Implemented in tenduke::oidc::device::DefaultOIDCDeviceFlow.


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