AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest Class Reference

#include <UpdateUserPoolClientRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest:

Public Member Functions

 UpdateUserPoolClientRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
UpdateUserPoolClientRequestWithUserPoolId (const Aws::String &value)
 
UpdateUserPoolClientRequestWithUserPoolId (Aws::String &&value)
 
UpdateUserPoolClientRequestWithUserPoolId (const char *value)
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
UpdateUserPoolClientRequestWithClientId (const Aws::String &value)
 
UpdateUserPoolClientRequestWithClientId (Aws::String &&value)
 
UpdateUserPoolClientRequestWithClientId (const char *value)
 
const Aws::StringGetClientName () const
 
bool ClientNameHasBeenSet () const
 
void SetClientName (const Aws::String &value)
 
void SetClientName (Aws::String &&value)
 
void SetClientName (const char *value)
 
UpdateUserPoolClientRequestWithClientName (const Aws::String &value)
 
UpdateUserPoolClientRequestWithClientName (Aws::String &&value)
 
UpdateUserPoolClientRequestWithClientName (const char *value)
 
int GetRefreshTokenValidity () const
 
bool RefreshTokenValidityHasBeenSet () const
 
void SetRefreshTokenValidity (int value)
 
UpdateUserPoolClientRequestWithRefreshTokenValidity (int value)
 
int GetAccessTokenValidity () const
 
bool AccessTokenValidityHasBeenSet () const
 
void SetAccessTokenValidity (int value)
 
UpdateUserPoolClientRequestWithAccessTokenValidity (int value)
 
int GetIdTokenValidity () const
 
bool IdTokenValidityHasBeenSet () const
 
void SetIdTokenValidity (int value)
 
UpdateUserPoolClientRequestWithIdTokenValidity (int value)
 
const TokenValidityUnitsTypeGetTokenValidityUnits () const
 
bool TokenValidityUnitsHasBeenSet () const
 
void SetTokenValidityUnits (const TokenValidityUnitsType &value)
 
void SetTokenValidityUnits (TokenValidityUnitsType &&value)
 
UpdateUserPoolClientRequestWithTokenValidityUnits (const TokenValidityUnitsType &value)
 
UpdateUserPoolClientRequestWithTokenValidityUnits (TokenValidityUnitsType &&value)
 
const Aws::Vector< Aws::String > & GetReadAttributes () const
 
bool ReadAttributesHasBeenSet () const
 
void SetReadAttributes (const Aws::Vector< Aws::String > &value)
 
void SetReadAttributes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithReadAttributes (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithReadAttributes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddReadAttributes (const Aws::String &value)
 
UpdateUserPoolClientRequestAddReadAttributes (Aws::String &&value)
 
UpdateUserPoolClientRequestAddReadAttributes (const char *value)
 
const Aws::Vector< Aws::String > & GetWriteAttributes () const
 
bool WriteAttributesHasBeenSet () const
 
void SetWriteAttributes (const Aws::Vector< Aws::String > &value)
 
void SetWriteAttributes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithWriteAttributes (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithWriteAttributes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddWriteAttributes (const Aws::String &value)
 
UpdateUserPoolClientRequestAddWriteAttributes (Aws::String &&value)
 
UpdateUserPoolClientRequestAddWriteAttributes (const char *value)
 
const Aws::Vector< ExplicitAuthFlowsType > & GetExplicitAuthFlows () const
 
bool ExplicitAuthFlowsHasBeenSet () const
 
void SetExplicitAuthFlows (const Aws::Vector< ExplicitAuthFlowsType > &value)
 
void SetExplicitAuthFlows (Aws::Vector< ExplicitAuthFlowsType > &&value)
 
UpdateUserPoolClientRequestWithExplicitAuthFlows (const Aws::Vector< ExplicitAuthFlowsType > &value)
 
UpdateUserPoolClientRequestWithExplicitAuthFlows (Aws::Vector< ExplicitAuthFlowsType > &&value)
 
UpdateUserPoolClientRequestAddExplicitAuthFlows (const ExplicitAuthFlowsType &value)
 
UpdateUserPoolClientRequestAddExplicitAuthFlows (ExplicitAuthFlowsType &&value)
 
const Aws::Vector< Aws::String > & GetSupportedIdentityProviders () const
 
bool SupportedIdentityProvidersHasBeenSet () const
 
void SetSupportedIdentityProviders (const Aws::Vector< Aws::String > &value)
 
void SetSupportedIdentityProviders (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithSupportedIdentityProviders (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithSupportedIdentityProviders (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddSupportedIdentityProviders (const Aws::String &value)
 
UpdateUserPoolClientRequestAddSupportedIdentityProviders (Aws::String &&value)
 
UpdateUserPoolClientRequestAddSupportedIdentityProviders (const char *value)
 
const Aws::Vector< Aws::String > & GetCallbackURLs () const
 
bool CallbackURLsHasBeenSet () const
 
void SetCallbackURLs (const Aws::Vector< Aws::String > &value)
 
void SetCallbackURLs (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithCallbackURLs (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithCallbackURLs (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddCallbackURLs (const Aws::String &value)
 
UpdateUserPoolClientRequestAddCallbackURLs (Aws::String &&value)
 
UpdateUserPoolClientRequestAddCallbackURLs (const char *value)
 
const Aws::Vector< Aws::String > & GetLogoutURLs () const
 
bool LogoutURLsHasBeenSet () const
 
void SetLogoutURLs (const Aws::Vector< Aws::String > &value)
 
void SetLogoutURLs (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithLogoutURLs (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithLogoutURLs (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddLogoutURLs (const Aws::String &value)
 
UpdateUserPoolClientRequestAddLogoutURLs (Aws::String &&value)
 
UpdateUserPoolClientRequestAddLogoutURLs (const char *value)
 
const Aws::StringGetDefaultRedirectURI () const
 
bool DefaultRedirectURIHasBeenSet () const
 
void SetDefaultRedirectURI (const Aws::String &value)
 
void SetDefaultRedirectURI (Aws::String &&value)
 
void SetDefaultRedirectURI (const char *value)
 
UpdateUserPoolClientRequestWithDefaultRedirectURI (const Aws::String &value)
 
UpdateUserPoolClientRequestWithDefaultRedirectURI (Aws::String &&value)
 
UpdateUserPoolClientRequestWithDefaultRedirectURI (const char *value)
 
const Aws::Vector< OAuthFlowType > & GetAllowedOAuthFlows () const
 
bool AllowedOAuthFlowsHasBeenSet () const
 
void SetAllowedOAuthFlows (const Aws::Vector< OAuthFlowType > &value)
 
void SetAllowedOAuthFlows (Aws::Vector< OAuthFlowType > &&value)
 
UpdateUserPoolClientRequestWithAllowedOAuthFlows (const Aws::Vector< OAuthFlowType > &value)
 
UpdateUserPoolClientRequestWithAllowedOAuthFlows (Aws::Vector< OAuthFlowType > &&value)
 
UpdateUserPoolClientRequestAddAllowedOAuthFlows (const OAuthFlowType &value)
 
UpdateUserPoolClientRequestAddAllowedOAuthFlows (OAuthFlowType &&value)
 
const Aws::Vector< Aws::String > & GetAllowedOAuthScopes () const
 
bool AllowedOAuthScopesHasBeenSet () const
 
void SetAllowedOAuthScopes (const Aws::Vector< Aws::String > &value)
 
void SetAllowedOAuthScopes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestWithAllowedOAuthScopes (const Aws::Vector< Aws::String > &value)
 
UpdateUserPoolClientRequestWithAllowedOAuthScopes (Aws::Vector< Aws::String > &&value)
 
UpdateUserPoolClientRequestAddAllowedOAuthScopes (const Aws::String &value)
 
UpdateUserPoolClientRequestAddAllowedOAuthScopes (Aws::String &&value)
 
UpdateUserPoolClientRequestAddAllowedOAuthScopes (const char *value)
 
bool GetAllowedOAuthFlowsUserPoolClient () const
 
bool AllowedOAuthFlowsUserPoolClientHasBeenSet () const
 
void SetAllowedOAuthFlowsUserPoolClient (bool value)
 
UpdateUserPoolClientRequestWithAllowedOAuthFlowsUserPoolClient (bool value)
 
const AnalyticsConfigurationTypeGetAnalyticsConfiguration () const
 
bool AnalyticsConfigurationHasBeenSet () const
 
void SetAnalyticsConfiguration (const AnalyticsConfigurationType &value)
 
void SetAnalyticsConfiguration (AnalyticsConfigurationType &&value)
 
UpdateUserPoolClientRequestWithAnalyticsConfiguration (const AnalyticsConfigurationType &value)
 
UpdateUserPoolClientRequestWithAnalyticsConfiguration (AnalyticsConfigurationType &&value)
 
const PreventUserExistenceErrorTypesGetPreventUserExistenceErrors () const
 
bool PreventUserExistenceErrorsHasBeenSet () const
 
void SetPreventUserExistenceErrors (const PreventUserExistenceErrorTypes &value)
 
void SetPreventUserExistenceErrors (PreventUserExistenceErrorTypes &&value)
 
UpdateUserPoolClientRequestWithPreventUserExistenceErrors (const PreventUserExistenceErrorTypes &value)
 
UpdateUserPoolClientRequestWithPreventUserExistenceErrors (PreventUserExistenceErrorTypes &&value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the request to update the user pool client.

See Also:

AWS API Reference

Definition at line 31 of file UpdateUserPoolClientRequest.h.

Constructor & Destructor Documentation

◆ UpdateUserPoolClientRequest()

Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::UpdateUserPoolClientRequest ( )

Member Function Documentation

◆ AccessTokenValidityHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AccessTokenValidityHasBeenSet ( ) const
inline

The time limit, after which the access token is no longer valid and cannot be used.

Definition at line 213 of file UpdateUserPoolClientRequest.h.

◆ AddAllowedOAuthFlows() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddAllowedOAuthFlows ( const OAuthFlowType value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 940 of file UpdateUserPoolClientRequest.h.

◆ AddAllowedOAuthFlows() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddAllowedOAuthFlows ( OAuthFlowType &&  value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 952 of file UpdateUserPoolClientRequest.h.

◆ AddAllowedOAuthScopes() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddAllowedOAuthScopes ( Aws::String &&  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 1025 of file UpdateUserPoolClientRequest.h.

◆ AddAllowedOAuthScopes() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddAllowedOAuthScopes ( const Aws::String value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 1016 of file UpdateUserPoolClientRequest.h.

◆ AddAllowedOAuthScopes() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddAllowedOAuthScopes ( const char *  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 1034 of file UpdateUserPoolClientRequest.h.

◆ AddCallbackURLs() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddCallbackURLs ( Aws::String &&  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 700 of file UpdateUserPoolClientRequest.h.

◆ AddCallbackURLs() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddCallbackURLs ( const Aws::String value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 688 of file UpdateUserPoolClientRequest.h.

◆ AddCallbackURLs() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddCallbackURLs ( const char *  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 712 of file UpdateUserPoolClientRequest.h.

◆ AddExplicitAuthFlows() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddExplicitAuthFlows ( const ExplicitAuthFlowsType value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 527 of file UpdateUserPoolClientRequest.h.

◆ AddExplicitAuthFlows() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddExplicitAuthFlows ( ExplicitAuthFlowsType &&  value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 548 of file UpdateUserPoolClientRequest.h.

◆ AddLogoutURLs() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddLogoutURLs ( Aws::String &&  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 753 of file UpdateUserPoolClientRequest.h.

◆ AddLogoutURLs() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddLogoutURLs ( const Aws::String value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 748 of file UpdateUserPoolClientRequest.h.

◆ AddLogoutURLs() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddLogoutURLs ( const char *  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 758 of file UpdateUserPoolClientRequest.h.

◆ AddReadAttributes() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddReadAttributes ( Aws::String &&  value)
inline

The read-only attributes of the user pool.

Definition at line 328 of file UpdateUserPoolClientRequest.h.

◆ AddReadAttributes() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddReadAttributes ( const Aws::String value)
inline

The read-only attributes of the user pool.

Definition at line 323 of file UpdateUserPoolClientRequest.h.

◆ AddReadAttributes() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddReadAttributes ( const char *  value)
inline

The read-only attributes of the user pool.

Definition at line 333 of file UpdateUserPoolClientRequest.h.

◆ AddSupportedIdentityProviders() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddSupportedIdentityProviders ( Aws::String &&  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 597 of file UpdateUserPoolClientRequest.h.

◆ AddSupportedIdentityProviders() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddSupportedIdentityProviders ( const Aws::String value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 591 of file UpdateUserPoolClientRequest.h.

◆ AddSupportedIdentityProviders() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddSupportedIdentityProviders ( const char *  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 603 of file UpdateUserPoolClientRequest.h.

◆ AddWriteAttributes() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddWriteAttributes ( Aws::String &&  value)
inline

The writeable attributes of the user pool.

Definition at line 374 of file UpdateUserPoolClientRequest.h.

◆ AddWriteAttributes() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddWriteAttributes ( const Aws::String value)
inline

The writeable attributes of the user pool.

Definition at line 369 of file UpdateUserPoolClientRequest.h.

◆ AddWriteAttributes() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AddWriteAttributes ( const char *  value)
inline

The writeable attributes of the user pool.

Definition at line 379 of file UpdateUserPoolClientRequest.h.

◆ AllowedOAuthFlowsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AllowedOAuthFlowsHasBeenSet ( ) const
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 880 of file UpdateUserPoolClientRequest.h.

◆ AllowedOAuthFlowsUserPoolClientHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AllowedOAuthFlowsUserPoolClientHasBeenSet ( ) const
inline

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Definition at line 1047 of file UpdateUserPoolClientRequest.h.

◆ AllowedOAuthScopesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AllowedOAuthScopesHasBeenSet ( ) const
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 971 of file UpdateUserPoolClientRequest.h.

◆ AnalyticsConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::AnalyticsConfigurationHasBeenSet ( ) const
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1080 of file UpdateUserPoolClientRequest.h.

◆ CallbackURLsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::CallbackURLsHasBeenSet ( ) const
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 628 of file UpdateUserPoolClientRequest.h.

◆ ClientIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::ClientIdHasBeenSet ( ) const
inline

The ID of the client associated with the user pool.

Definition at line 104 of file UpdateUserPoolClientRequest.h.

◆ ClientNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::ClientNameHasBeenSet ( ) const
inline

The client name from the update user pool client request.

Definition at line 145 of file UpdateUserPoolClientRequest.h.

◆ DefaultRedirectURIHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::DefaultRedirectURIHasBeenSet ( ) const
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 783 of file UpdateUserPoolClientRequest.h.

◆ ExplicitAuthFlowsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::ExplicitAuthFlowsHasBeenSet ( ) const
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 422 of file UpdateUserPoolClientRequest.h.

◆ GetAccessTokenValidity()

int Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetAccessTokenValidity ( ) const
inline

The time limit, after which the access token is no longer valid and cannot be used.

Definition at line 207 of file UpdateUserPoolClientRequest.h.

◆ GetAllowedOAuthFlows()

const Aws::Vector<OAuthFlowType>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetAllowedOAuthFlows ( ) const
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 868 of file UpdateUserPoolClientRequest.h.

◆ GetAllowedOAuthFlowsUserPoolClient()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetAllowedOAuthFlowsUserPoolClient ( ) const
inline

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Definition at line 1041 of file UpdateUserPoolClientRequest.h.

◆ GetAllowedOAuthScopes()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetAllowedOAuthScopes ( ) const
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 962 of file UpdateUserPoolClientRequest.h.

◆ GetAnalyticsConfiguration()

const AnalyticsConfigurationType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetAnalyticsConfiguration ( ) const
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1070 of file UpdateUserPoolClientRequest.h.

◆ GetCallbackURLs()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetCallbackURLs ( ) const
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 616 of file UpdateUserPoolClientRequest.h.

◆ GetClientId()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetClientId ( ) const
inline

The ID of the client associated with the user pool.

Definition at line 99 of file UpdateUserPoolClientRequest.h.

◆ GetClientName()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetClientName ( ) const
inline

The client name from the update user pool client request.

Definition at line 140 of file UpdateUserPoolClientRequest.h.

◆ GetDefaultRedirectURI()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetDefaultRedirectURI ( ) const
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 771 of file UpdateUserPoolClientRequest.h.

◆ GetExplicitAuthFlows()

const Aws::Vector<ExplicitAuthFlowsType>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetExplicitAuthFlows ( ) const
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 401 of file UpdateUserPoolClientRequest.h.

◆ GetIdTokenValidity()

int Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetIdTokenValidity ( ) const
inline

The time limit, after which the ID token is no longer valid and cannot be used.

Definition at line 232 of file UpdateUserPoolClientRequest.h.

◆ GetLogoutURLs()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetLogoutURLs ( ) const
inline

A list of allowed logout URLs for the identity providers.

Definition at line 718 of file UpdateUserPoolClientRequest.h.

◆ GetPreventUserExistenceErrors()

const PreventUserExistenceErrorTypes& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetPreventUserExistenceErrors ( ) const
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1140 of file UpdateUserPoolClientRequest.h.

◆ GetReadAttributes()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetReadAttributes ( ) const
inline

The read-only attributes of the user pool.

Definition at line 293 of file UpdateUserPoolClientRequest.h.

◆ GetRefreshTokenValidity()

int Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetRefreshTokenValidity ( ) const
inline

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Definition at line 182 of file UpdateUserPoolClientRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file UpdateUserPoolClientRequest.h.

◆ GetSupportedIdentityProviders()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetSupportedIdentityProviders ( ) const
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 555 of file UpdateUserPoolClientRequest.h.

◆ GetTokenValidityUnits()

const TokenValidityUnitsType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetTokenValidityUnits ( ) const
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 257 of file UpdateUserPoolClientRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 51 of file UpdateUserPoolClientRequest.h.

◆ GetWriteAttributes()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::GetWriteAttributes ( ) const
inline

The writeable attributes of the user pool.

Definition at line 339 of file UpdateUserPoolClientRequest.h.

◆ IdTokenValidityHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::IdTokenValidityHasBeenSet ( ) const
inline

The time limit, after which the ID token is no longer valid and cannot be used.

Definition at line 238 of file UpdateUserPoolClientRequest.h.

◆ LogoutURLsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::LogoutURLsHasBeenSet ( ) const
inline

A list of allowed logout URLs for the identity providers.

Definition at line 723 of file UpdateUserPoolClientRequest.h.

◆ PreventUserExistenceErrorsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::PreventUserExistenceErrorsHasBeenSet ( ) const
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1159 of file UpdateUserPoolClientRequest.h.

◆ ReadAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::ReadAttributesHasBeenSet ( ) const
inline

The read-only attributes of the user pool.

Definition at line 298 of file UpdateUserPoolClientRequest.h.

◆ RefreshTokenValidityHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::RefreshTokenValidityHasBeenSet ( ) const
inline

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Definition at line 188 of file UpdateUserPoolClientRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccessTokenValidity()

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAccessTokenValidity ( int  value)
inline

The time limit, after which the access token is no longer valid and cannot be used.

Definition at line 219 of file UpdateUserPoolClientRequest.h.

◆ SetAllowedOAuthFlows() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAllowedOAuthFlows ( Aws::Vector< OAuthFlowType > &&  value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 904 of file UpdateUserPoolClientRequest.h.

◆ SetAllowedOAuthFlows() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAllowedOAuthFlows ( const Aws::Vector< OAuthFlowType > &  value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 892 of file UpdateUserPoolClientRequest.h.

◆ SetAllowedOAuthFlowsUserPoolClient()

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAllowedOAuthFlowsUserPoolClient ( bool  value)
inline

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Definition at line 1053 of file UpdateUserPoolClientRequest.h.

◆ SetAllowedOAuthScopes() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAllowedOAuthScopes ( Aws::Vector< Aws::String > &&  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 989 of file UpdateUserPoolClientRequest.h.

◆ SetAllowedOAuthScopes() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAllowedOAuthScopes ( const Aws::Vector< Aws::String > &  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 980 of file UpdateUserPoolClientRequest.h.

◆ SetAnalyticsConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAnalyticsConfiguration ( AnalyticsConfigurationType &&  value)
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1100 of file UpdateUserPoolClientRequest.h.

◆ SetAnalyticsConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetAnalyticsConfiguration ( const AnalyticsConfigurationType value)
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1090 of file UpdateUserPoolClientRequest.h.

◆ SetCallbackURLs() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetCallbackURLs ( Aws::Vector< Aws::String > &&  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 652 of file UpdateUserPoolClientRequest.h.

◆ SetCallbackURLs() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetCallbackURLs ( const Aws::Vector< Aws::String > &  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 640 of file UpdateUserPoolClientRequest.h.

◆ SetClientId() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientId ( Aws::String &&  value)
inline

The ID of the client associated with the user pool.

Definition at line 114 of file UpdateUserPoolClientRequest.h.

◆ SetClientId() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientId ( const Aws::String value)
inline

The ID of the client associated with the user pool.

Definition at line 109 of file UpdateUserPoolClientRequest.h.

◆ SetClientId() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientId ( const char *  value)
inline

The ID of the client associated with the user pool.

Definition at line 119 of file UpdateUserPoolClientRequest.h.

◆ SetClientName() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientName ( Aws::String &&  value)
inline

The client name from the update user pool client request.

Definition at line 155 of file UpdateUserPoolClientRequest.h.

◆ SetClientName() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientName ( const Aws::String value)
inline

The client name from the update user pool client request.

Definition at line 150 of file UpdateUserPoolClientRequest.h.

◆ SetClientName() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetClientName ( const char *  value)
inline

The client name from the update user pool client request.

Definition at line 160 of file UpdateUserPoolClientRequest.h.

◆ SetDefaultRedirectURI() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetDefaultRedirectURI ( Aws::String &&  value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 807 of file UpdateUserPoolClientRequest.h.

◆ SetDefaultRedirectURI() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetDefaultRedirectURI ( const Aws::String value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 795 of file UpdateUserPoolClientRequest.h.

◆ SetDefaultRedirectURI() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetDefaultRedirectURI ( const char *  value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 819 of file UpdateUserPoolClientRequest.h.

◆ SetExplicitAuthFlows() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetExplicitAuthFlows ( Aws::Vector< ExplicitAuthFlowsType > &&  value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 464 of file UpdateUserPoolClientRequest.h.

◆ SetExplicitAuthFlows() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetExplicitAuthFlows ( const Aws::Vector< ExplicitAuthFlowsType > &  value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 443 of file UpdateUserPoolClientRequest.h.

◆ SetIdTokenValidity()

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetIdTokenValidity ( int  value)
inline

The time limit, after which the ID token is no longer valid and cannot be used.

Definition at line 244 of file UpdateUserPoolClientRequest.h.

◆ SetLogoutURLs() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetLogoutURLs ( Aws::Vector< Aws::String > &&  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 733 of file UpdateUserPoolClientRequest.h.

◆ SetLogoutURLs() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetLogoutURLs ( const Aws::Vector< Aws::String > &  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 728 of file UpdateUserPoolClientRequest.h.

◆ SetPreventUserExistenceErrors() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetPreventUserExistenceErrors ( const PreventUserExistenceErrorTypes value)
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1178 of file UpdateUserPoolClientRequest.h.

◆ SetPreventUserExistenceErrors() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetPreventUserExistenceErrors ( PreventUserExistenceErrorTypes &&  value)
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1197 of file UpdateUserPoolClientRequest.h.

◆ SetReadAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetReadAttributes ( Aws::Vector< Aws::String > &&  value)
inline

The read-only attributes of the user pool.

Definition at line 308 of file UpdateUserPoolClientRequest.h.

◆ SetReadAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetReadAttributes ( const Aws::Vector< Aws::String > &  value)
inline

The read-only attributes of the user pool.

Definition at line 303 of file UpdateUserPoolClientRequest.h.

◆ SetRefreshTokenValidity()

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetRefreshTokenValidity ( int  value)
inline

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Definition at line 194 of file UpdateUserPoolClientRequest.h.

◆ SetSupportedIdentityProviders() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetSupportedIdentityProviders ( Aws::Vector< Aws::String > &&  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 573 of file UpdateUserPoolClientRequest.h.

◆ SetSupportedIdentityProviders() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetSupportedIdentityProviders ( const Aws::Vector< Aws::String > &  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 567 of file UpdateUserPoolClientRequest.h.

◆ SetTokenValidityUnits() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetTokenValidityUnits ( const TokenValidityUnitsType value)
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 269 of file UpdateUserPoolClientRequest.h.

◆ SetTokenValidityUnits() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetTokenValidityUnits ( TokenValidityUnitsType &&  value)
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 275 of file UpdateUserPoolClientRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 69 of file UpdateUserPoolClientRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 63 of file UpdateUserPoolClientRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 75 of file UpdateUserPoolClientRequest.h.

◆ SetWriteAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetWriteAttributes ( Aws::Vector< Aws::String > &&  value)
inline

The writeable attributes of the user pool.

Definition at line 354 of file UpdateUserPoolClientRequest.h.

◆ SetWriteAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SetWriteAttributes ( const Aws::Vector< Aws::String > &  value)
inline

The writeable attributes of the user pool.

Definition at line 349 of file UpdateUserPoolClientRequest.h.

◆ SupportedIdentityProvidersHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::SupportedIdentityProvidersHasBeenSet ( ) const
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 561 of file UpdateUserPoolClientRequest.h.

◆ TokenValidityUnitsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::TokenValidityUnitsHasBeenSet ( ) const
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 263 of file UpdateUserPoolClientRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 57 of file UpdateUserPoolClientRequest.h.

◆ WithAccessTokenValidity()

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAccessTokenValidity ( int  value)
inline

The time limit, after which the access token is no longer valid and cannot be used.

Definition at line 225 of file UpdateUserPoolClientRequest.h.

◆ WithAllowedOAuthFlows() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAllowedOAuthFlows ( Aws::Vector< OAuthFlowType > &&  value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 928 of file UpdateUserPoolClientRequest.h.

◆ WithAllowedOAuthFlows() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAllowedOAuthFlows ( const Aws::Vector< OAuthFlowType > &  value)
inline

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Definition at line 916 of file UpdateUserPoolClientRequest.h.

◆ WithAllowedOAuthFlowsUserPoolClient()

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAllowedOAuthFlowsUserPoolClient ( bool  value)
inline

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Definition at line 1059 of file UpdateUserPoolClientRequest.h.

◆ WithAllowedOAuthScopes() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAllowedOAuthScopes ( Aws::Vector< Aws::String > &&  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 1007 of file UpdateUserPoolClientRequest.h.

◆ WithAllowedOAuthScopes() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAllowedOAuthScopes ( const Aws::Vector< Aws::String > &  value)
inline

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Definition at line 998 of file UpdateUserPoolClientRequest.h.

◆ WithAnalyticsConfiguration() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAnalyticsConfiguration ( AnalyticsConfigurationType &&  value)
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1120 of file UpdateUserPoolClientRequest.h.

◆ WithAnalyticsConfiguration() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithAnalyticsConfiguration ( const AnalyticsConfigurationType value)
inline

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Definition at line 1110 of file UpdateUserPoolClientRequest.h.

◆ WithCallbackURLs() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithCallbackURLs ( Aws::Vector< Aws::String > &&  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 676 of file UpdateUserPoolClientRequest.h.

◆ WithCallbackURLs() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithCallbackURLs ( const Aws::Vector< Aws::String > &  value)
inline

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 664 of file UpdateUserPoolClientRequest.h.

◆ WithClientId() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientId ( Aws::String &&  value)
inline

The ID of the client associated with the user pool.

Definition at line 129 of file UpdateUserPoolClientRequest.h.

◆ WithClientId() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientId ( const Aws::String value)
inline

The ID of the client associated with the user pool.

Definition at line 124 of file UpdateUserPoolClientRequest.h.

◆ WithClientId() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientId ( const char *  value)
inline

The ID of the client associated with the user pool.

Definition at line 134 of file UpdateUserPoolClientRequest.h.

◆ WithClientName() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientName ( Aws::String &&  value)
inline

The client name from the update user pool client request.

Definition at line 170 of file UpdateUserPoolClientRequest.h.

◆ WithClientName() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientName ( const Aws::String value)
inline

The client name from the update user pool client request.

Definition at line 165 of file UpdateUserPoolClientRequest.h.

◆ WithClientName() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithClientName ( const char *  value)
inline

The client name from the update user pool client request.

Definition at line 175 of file UpdateUserPoolClientRequest.h.

◆ WithDefaultRedirectURI() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithDefaultRedirectURI ( Aws::String &&  value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 843 of file UpdateUserPoolClientRequest.h.

◆ WithDefaultRedirectURI() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithDefaultRedirectURI ( const Aws::String value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 831 of file UpdateUserPoolClientRequest.h.

◆ WithDefaultRedirectURI() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithDefaultRedirectURI ( const char *  value)
inline

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Definition at line 855 of file UpdateUserPoolClientRequest.h.

◆ WithExplicitAuthFlows() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithExplicitAuthFlows ( Aws::Vector< ExplicitAuthFlowsType > &&  value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 506 of file UpdateUserPoolClientRequest.h.

◆ WithExplicitAuthFlows() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithExplicitAuthFlows ( const Aws::Vector< ExplicitAuthFlowsType > &  value)
inline

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Definition at line 485 of file UpdateUserPoolClientRequest.h.

◆ WithIdTokenValidity()

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithIdTokenValidity ( int  value)
inline

The time limit, after which the ID token is no longer valid and cannot be used.

Definition at line 250 of file UpdateUserPoolClientRequest.h.

◆ WithLogoutURLs() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithLogoutURLs ( Aws::Vector< Aws::String > &&  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 743 of file UpdateUserPoolClientRequest.h.

◆ WithLogoutURLs() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithLogoutURLs ( const Aws::Vector< Aws::String > &  value)
inline

A list of allowed logout URLs for the identity providers.

Definition at line 738 of file UpdateUserPoolClientRequest.h.

◆ WithPreventUserExistenceErrors() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithPreventUserExistenceErrors ( const PreventUserExistenceErrorTypes value)
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1216 of file UpdateUserPoolClientRequest.h.

◆ WithPreventUserExistenceErrors() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithPreventUserExistenceErrors ( PreventUserExistenceErrorTypes &&  value)
inline

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Definition at line 1235 of file UpdateUserPoolClientRequest.h.

◆ WithReadAttributes() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithReadAttributes ( Aws::Vector< Aws::String > &&  value)
inline

The read-only attributes of the user pool.

Definition at line 318 of file UpdateUserPoolClientRequest.h.

◆ WithReadAttributes() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithReadAttributes ( const Aws::Vector< Aws::String > &  value)
inline

The read-only attributes of the user pool.

Definition at line 313 of file UpdateUserPoolClientRequest.h.

◆ WithRefreshTokenValidity()

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithRefreshTokenValidity ( int  value)
inline

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Definition at line 200 of file UpdateUserPoolClientRequest.h.

◆ WithSupportedIdentityProviders() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithSupportedIdentityProviders ( Aws::Vector< Aws::String > &&  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 585 of file UpdateUserPoolClientRequest.h.

◆ WithSupportedIdentityProviders() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithSupportedIdentityProviders ( const Aws::Vector< Aws::String > &  value)
inline

A list of provider names for the identity providers that are supported on this client.

Definition at line 579 of file UpdateUserPoolClientRequest.h.

◆ WithTokenValidityUnits() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithTokenValidityUnits ( const TokenValidityUnitsType value)
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 281 of file UpdateUserPoolClientRequest.h.

◆ WithTokenValidityUnits() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithTokenValidityUnits ( TokenValidityUnitsType &&  value)
inline

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

Definition at line 287 of file UpdateUserPoolClientRequest.h.

◆ WithUserPoolId() [1/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 87 of file UpdateUserPoolClientRequest.h.

◆ WithUserPoolId() [2/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 81 of file UpdateUserPoolClientRequest.h.

◆ WithUserPoolId() [3/3]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where you want to update the user pool client.

Definition at line 93 of file UpdateUserPoolClientRequest.h.

◆ WithWriteAttributes() [1/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithWriteAttributes ( Aws::Vector< Aws::String > &&  value)
inline

The writeable attributes of the user pool.

Definition at line 364 of file UpdateUserPoolClientRequest.h.

◆ WithWriteAttributes() [2/2]

UpdateUserPoolClientRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WithWriteAttributes ( const Aws::Vector< Aws::String > &  value)
inline

The writeable attributes of the user pool.

Definition at line 359 of file UpdateUserPoolClientRequest.h.

◆ WriteAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolClientRequest::WriteAttributesHasBeenSet ( ) const
inline

The writeable attributes of the user pool.

Definition at line 344 of file UpdateUserPoolClientRequest.h.


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