10Duke Scale C++ Client
Loading...
Searching...
No Matches
tenduke::oauth::OAuthClientConfiguration Class Reference

#include <OAuthClientConfiguration.h>

Detailed Description

Container for OAuth-client-configuration.

This describes the OAuth-client.

Inheritance diagram for tenduke::oauth::OAuthClientConfiguration:
tenduke::oauth::OAuthConfiguration

Classes

class  Builder
 Builder for the configuration. More...
 

Public Types

enum  OAuthFlow { UNKNOWN , PKCE , DEVICE }
 Type of the OAuth flow.
 

Public Member Functions

 OAuthClientConfiguration (std::string clientId, std::string clientSecret, std::string redirectURI, const enum OAuthFlow flow)
 Constructs new instance.
 

Static Public Member Functions

static std::string flowToString (const enum OAuthFlow flow)
 Converts the flow to a string representation.
 
static enum OAuthFlow stringToFlow (const std::string &string)
 Parses string representation of a flow.
 
static Builder forPKCEFlow ()
 Starts building configuration for PKCE-flow.
 

Public Attributes

const std::string clientId
 OAuth 2 client id, configured also in the server.
 
const std::string clientSecret
 (Optional) OAuth 2 client secret, configured also in the server.
 
const std::string redirectURI
 OAuth2 redirect-URI for browser-based based authentication.
 
enum OAuthFlow flow
 The flow.
 

Constructor & Destructor Documentation

◆ OAuthClientConfiguration()

tenduke::oauth::OAuthClientConfiguration::OAuthClientConfiguration ( std::string  clientId,
std::string  clientSecret,
std::string  redirectURI,
const enum OAuthFlow  flow 
)
inline

Constructs new instance.

Parameters
clientId
clientSecret
redirectURI
flow

Member Function Documentation

◆ flowToString()

static std::string tenduke::oauth::OAuthClientConfiguration::flowToString ( const enum OAuthFlow  flow)
inlinestatic

Converts the flow to a string representation.

Parameters
flow-
Returns
-

◆ forPKCEFlow()

static Builder tenduke::oauth::OAuthClientConfiguration::forPKCEFlow ( )
inlinestatic

Starts building configuration for PKCE-flow.

Returns
fluent builder.

◆ stringToFlow()

static enum OAuthFlow tenduke::oauth::OAuthClientConfiguration::stringToFlow ( const std::string &  string)
inlinestatic

Parses string representation of a flow.

Parameters
string-
Returns
-

Member Data Documentation

◆ redirectURI

const std::string tenduke::oauth::OAuthClientConfiguration::redirectURI

OAuth2 redirect-URI for browser-based based authentication.

Also configured in the server.


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