/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Request parameters when using an identity provider (IdP) that is compliant
* with OpenID Connect (OIDC) to authenticate users.See Also:
AWS
* API Reference
The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline const Aws::String& GetIssuer() const{ return m_issuer; } /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline bool IssuerHasBeenSet() const { return m_issuerHasBeenSet; } /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetIssuer(const Aws::String& value) { m_issuerHasBeenSet = true; m_issuer = value; } /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetIssuer(Aws::String&& value) { m_issuerHasBeenSet = true; m_issuer = std::move(value); } /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetIssuer(const char* value) { m_issuerHasBeenSet = true; m_issuer.assign(value); } /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithIssuer(const Aws::String& value) { SetIssuer(value); return *this;} /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithIssuer(Aws::String&& value) { SetIssuer(std::move(value)); return *this;} /** *The OIDC issuer identifier of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithIssuer(const char* value) { SetIssuer(value); return *this;} /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline const Aws::String& GetAuthorizationEndpoint() const{ return m_authorizationEndpoint; } /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline bool AuthorizationEndpointHasBeenSet() const { return m_authorizationEndpointHasBeenSet; } /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetAuthorizationEndpoint(const Aws::String& value) { m_authorizationEndpointHasBeenSet = true; m_authorizationEndpoint = value; } /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetAuthorizationEndpoint(Aws::String&& value) { m_authorizationEndpointHasBeenSet = true; m_authorizationEndpoint = std::move(value); } /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetAuthorizationEndpoint(const char* value) { m_authorizationEndpointHasBeenSet = true; m_authorizationEndpoint.assign(value); } /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithAuthorizationEndpoint(const Aws::String& value) { SetAuthorizationEndpoint(value); return *this;} /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithAuthorizationEndpoint(Aws::String&& value) { SetAuthorizationEndpoint(std::move(value)); return *this;} /** *The authorization endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithAuthorizationEndpoint(const char* value) { SetAuthorizationEndpoint(value); return *this;} /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline const Aws::String& GetTokenEndpoint() const{ return m_tokenEndpoint; } /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline bool TokenEndpointHasBeenSet() const { return m_tokenEndpointHasBeenSet; } /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline void SetTokenEndpoint(const Aws::String& value) { m_tokenEndpointHasBeenSet = true; m_tokenEndpoint = value; } /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline void SetTokenEndpoint(Aws::String&& value) { m_tokenEndpointHasBeenSet = true; m_tokenEndpoint = std::move(value); } /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline void SetTokenEndpoint(const char* value) { m_tokenEndpointHasBeenSet = true; m_tokenEndpoint.assign(value); } /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithTokenEndpoint(const Aws::String& value) { SetTokenEndpoint(value); return *this;} /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithTokenEndpoint(Aws::String&& value) { SetTokenEndpoint(std::move(value)); return *this;} /** *The token endpoint of the IdP. This must be a full URL, including the HTTPS * protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithTokenEndpoint(const char* value) { SetTokenEndpoint(value); return *this;} /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline const Aws::String& GetUserInfoEndpoint() const{ return m_userInfoEndpoint; } /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline bool UserInfoEndpointHasBeenSet() const { return m_userInfoEndpointHasBeenSet; } /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetUserInfoEndpoint(const Aws::String& value) { m_userInfoEndpointHasBeenSet = true; m_userInfoEndpoint = value; } /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetUserInfoEndpoint(Aws::String&& value) { m_userInfoEndpointHasBeenSet = true; m_userInfoEndpoint = std::move(value); } /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline void SetUserInfoEndpoint(const char* value) { m_userInfoEndpointHasBeenSet = true; m_userInfoEndpoint.assign(value); } /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithUserInfoEndpoint(const Aws::String& value) { SetUserInfoEndpoint(value); return *this;} /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithUserInfoEndpoint(Aws::String&& value) { SetUserInfoEndpoint(std::move(value)); return *this;} /** *The user info endpoint of the IdP. This must be a full URL, including the * HTTPS protocol, the domain, and the path.
*/ inline AuthenticateOidcActionConfig& WithUserInfoEndpoint(const char* value) { SetUserInfoEndpoint(value); return *this;} /** *The OAuth 2.0 client identifier.
*/ inline const Aws::String& GetClientId() const{ return m_clientId; } /** *The OAuth 2.0 client identifier.
*/ inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; } /** *The OAuth 2.0 client identifier.
*/ inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; } /** *The OAuth 2.0 client identifier.
*/ inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); } /** *The OAuth 2.0 client identifier.
*/ inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); } /** *The OAuth 2.0 client identifier.
*/ inline AuthenticateOidcActionConfig& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *The OAuth 2.0 client identifier.
*/ inline AuthenticateOidcActionConfig& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *The OAuth 2.0 client identifier.
*/ inline AuthenticateOidcActionConfig& WithClientId(const char* value) { SetClientId(value); return *this;} /** *The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The OAuth 2.0 client secret. This parameter is required if you are creating a
* rule. If you are modifying a rule, you can omit this parameter if you set
* UseExistingClientSecret
to true.
The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline const Aws::String& GetSessionCookieName() const{ return m_sessionCookieName; } /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline bool SessionCookieNameHasBeenSet() const { return m_sessionCookieNameHasBeenSet; } /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline void SetSessionCookieName(const Aws::String& value) { m_sessionCookieNameHasBeenSet = true; m_sessionCookieName = value; } /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline void SetSessionCookieName(Aws::String&& value) { m_sessionCookieNameHasBeenSet = true; m_sessionCookieName = std::move(value); } /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline void SetSessionCookieName(const char* value) { m_sessionCookieNameHasBeenSet = true; m_sessionCookieName.assign(value); } /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline AuthenticateOidcActionConfig& WithSessionCookieName(const Aws::String& value) { SetSessionCookieName(value); return *this;} /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline AuthenticateOidcActionConfig& WithSessionCookieName(Aws::String&& value) { SetSessionCookieName(std::move(value)); return *this;} /** *The name of the cookie used to maintain session information. The default is * AWSELBAuthSessionCookie.
*/ inline AuthenticateOidcActionConfig& WithSessionCookieName(const char* value) { SetSessionCookieName(value); return *this;} /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline const Aws::String& GetScope() const{ return m_scope; } /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; } /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline void SetScope(const Aws::String& value) { m_scopeHasBeenSet = true; m_scope = value; } /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline void SetScope(Aws::String&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); } /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline void SetScope(const char* value) { m_scopeHasBeenSet = true; m_scope.assign(value); } /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline AuthenticateOidcActionConfig& WithScope(const Aws::String& value) { SetScope(value); return *this;} /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline AuthenticateOidcActionConfig& WithScope(Aws::String&& value) { SetScope(std::move(value)); return *this;} /** *The set of user claims to be requested from the IdP. The default is
* openid
.
To verify which scope values your IdP supports and * how to separate multiple values, see the documentation for your IdP.
*/ inline AuthenticateOidcActionConfig& WithScope(const char* value) { SetScope(value); return *this;} /** *The maximum duration of the authentication session, in seconds. The default * is 604800 seconds (7 days).
*/ inline long long GetSessionTimeout() const{ return m_sessionTimeout; } /** *The maximum duration of the authentication session, in seconds. The default * is 604800 seconds (7 days).
*/ inline bool SessionTimeoutHasBeenSet() const { return m_sessionTimeoutHasBeenSet; } /** *The maximum duration of the authentication session, in seconds. The default * is 604800 seconds (7 days).
*/ inline void SetSessionTimeout(long long value) { m_sessionTimeoutHasBeenSet = true; m_sessionTimeout = value; } /** *The maximum duration of the authentication session, in seconds. The default * is 604800 seconds (7 days).
*/ inline AuthenticateOidcActionConfig& WithSessionTimeout(long long value) { SetSessionTimeout(value); return *this;} /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline const Aws::MapThe query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline bool AuthenticationRequestExtraParamsHasBeenSet() const { return m_authenticationRequestExtraParamsHasBeenSet; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline void SetAuthenticationRequestExtraParams(const Aws::MapThe query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline void SetAuthenticationRequestExtraParams(Aws::MapThe query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& WithAuthenticationRequestExtraParams(const Aws::MapThe query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& WithAuthenticationRequestExtraParams(Aws::MapThe query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(const Aws::String& key, const Aws::String& value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(key, value); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(Aws::String&& key, const Aws::String& value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(std::move(key), value); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(const Aws::String& key, Aws::String&& value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(key, std::move(value)); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(Aws::String&& key, Aws::String&& value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(std::move(key), std::move(value)); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(const char* key, Aws::String&& value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(key, std::move(value)); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(Aws::String&& key, const char* value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(std::move(key), value); return *this; } /** *The query parameters (up to 10) to include in the redirect request to the * authorization endpoint.
*/ inline AuthenticateOidcActionConfig& AddAuthenticationRequestExtraParams(const char* key, const char* value) { m_authenticationRequestExtraParamsHasBeenSet = true; m_authenticationRequestExtraParams.emplace(key, value); return *this; } /** *The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
The behavior if the user is not authenticated. The following are possible * values:
deny - Return an HTTP 401 Unauthorized
* error.
allow - Allow the request to be forwarded to the
* target.
authenticate - Redirect the request to the IdP
* authorization endpoint. This is the default value.
Indicates whether to use the existing client secret when modifying a rule. If * you are creating a rule, you can omit this parameter or set it to false.
*/ inline bool GetUseExistingClientSecret() const{ return m_useExistingClientSecret; } /** *Indicates whether to use the existing client secret when modifying a rule. If * you are creating a rule, you can omit this parameter or set it to false.
*/ inline bool UseExistingClientSecretHasBeenSet() const { return m_useExistingClientSecretHasBeenSet; } /** *Indicates whether to use the existing client secret when modifying a rule. If * you are creating a rule, you can omit this parameter or set it to false.
*/ inline void SetUseExistingClientSecret(bool value) { m_useExistingClientSecretHasBeenSet = true; m_useExistingClientSecret = value; } /** *Indicates whether to use the existing client secret when modifying a rule. If * you are creating a rule, you can omit this parameter or set it to false.
*/ inline AuthenticateOidcActionConfig& WithUseExistingClientSecret(bool value) { SetUseExistingClientSecret(value); return *this;} private: Aws::String m_issuer; bool m_issuerHasBeenSet = false; Aws::String m_authorizationEndpoint; bool m_authorizationEndpointHasBeenSet = false; Aws::String m_tokenEndpoint; bool m_tokenEndpointHasBeenSet = false; Aws::String m_userInfoEndpoint; bool m_userInfoEndpointHasBeenSet = false; Aws::String m_clientId; bool m_clientIdHasBeenSet = false; Aws::String m_clientSecret; bool m_clientSecretHasBeenSet = false; Aws::String m_sessionCookieName; bool m_sessionCookieNameHasBeenSet = false; Aws::String m_scope; bool m_scopeHasBeenSet = false; long long m_sessionTimeout; bool m_sessionTimeoutHasBeenSet = false; Aws::Map