10Duke Scale C++ Client
Loading...
Searching...
No Matches
ROPGAuthenticationConfig Class Reference
Inheritance diagram for ROPGAuthenticationConfig:
tenduke::oidc::BaseOIDCAuthenticationConfig

Public Member Functions

 ROPGAuthenticationConfig (const ::tenduke::oauth::ropg::ResourceOwnerPasswordCredentialsProvider &credentialsProvider, std::string oauthClientId, std::string oauthClientSecret={}, const std::uint32_t maxLoginAttempts=DEFAULT_LOGIN_ATTEMPTS, ::tenduke::oidc::OIDCSessionConfiguration oidcSessionConfiguration={}, std::string scopes={})
 Creates a new instance.
 
std::uint32_t getMaxLoginAttempts () const
 Returns maximum number of login attempts.
 
- Public Member Functions inherited from tenduke::oidc::BaseOIDCAuthenticationConfig
 BaseOIDCAuthenticationConfig (std::string oauthClientId, std::string oauthClientSecret={}, ::tenduke::oidc::OIDCSessionConfiguration oidcSessionConfiguration={}, std::string scopes={})
 

Public Attributes

const ::tenduke::oauth::ropg::ResourceOwnerPasswordCredentialsProvidercredentialsProvider
 
const std::uint32_t maxLoginAttempts
 
- Public Attributes inherited from tenduke::oidc::BaseOIDCAuthenticationConfig
const std::string oauthClientId
 OAuth client id.
 
const std::string oauthClientSecret
 OAuth client secret.
 
const ::tenduke::oidc::OIDCSessionConfiguration oidcSessionConfiguration
 OIDC session configuration.
 
const std::string scopes
 OAuth/OIDC scopes to authorize.
 

Static Public Attributes

static constexpr std::uint32_t DEFAULT_LOGIN_ATTEMPTS = 0
 
static constexpr std::uint32_t UNLIMITED_LOGIN_ATTEMPTS = UINT32_MAX
 

Constructor & Destructor Documentation

◆ ROPGAuthenticationConfig()

tenduke::oidc::ropg::ROPGAuthenticationConfig::ROPGAuthenticationConfig ( const ::tenduke::oauth::ropg::ResourceOwnerPasswordCredentialsProvider & credentialsProvider,
std::string oauthClientId,
std::string oauthClientSecret = {},
const std::uint32_t maxLoginAttempts = DEFAULT_LOGIN_ATTEMPTS,
::tenduke::oidc::OIDCSessionConfiguration oidcSessionConfiguration = {},
std::string scopes = {} )
inline

Creates a new instance.

Parameters
credentialsProvidercallback to provide the login credentials when performing authentication
oauthClientIdOAuth client id
oauthClientSecretOAuth client secret
maxLoginAttemptsmaximum number of login attempts. Once all attempts are used up, the operation throws tenduke::oauth::OAuthInvalidGrant. This is per login request. 0 is unlimited.
oidcSessionConfigurationOIDC session configuration
scopesOAuth scopes to request

Member Function Documentation

◆ getMaxLoginAttempts()

std::uint32_t tenduke::oidc::ropg::ROPGAuthenticationConfig::getMaxLoginAttempts ( ) const
inline

Returns maximum number of login attempts.

Returns
the maximum number of login attempts

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