All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.cognitoidp.model.CreateUserPoolClientRequest Maven / Gradle / Ivy

/*
 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.cognitoidp.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 

* Represents the request to create a user pool client. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateUserPoolClientRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The user pool ID for the user pool where you want to create a user pool client. *

*/ private String userPoolId; /** *

* The client name for the user pool client you would like to create. *

*/ private String clientName; /** *

* Boolean to specify whether you want to generate a secret for the user pool client being created. *

*/ private Boolean generateSecret; /** *

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

*/ private Integer refreshTokenValidity; /** *

* The read attributes. *

*/ private java.util.List readAttributes; /** *

* The user pool attributes that the app client can write to. *

*

* If your app client allows users to sign in through an identity provider, this array must include all attributes * that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to * your application through an identity provider. If your app client lacks write access to a mapped attribute, * Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. *

*/ private java.util.List writeAttributes; /** *

* 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. *

    *
  • *
*/ private java.util.List explicitAuthFlows; /** *

* A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and LoginWithAmazon. *

*/ private java.util.List supportedIdentityProviders; /** *

* 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. *

*/ private java.util.List callbackURLs; /** *

* A list of allowed logout URLs for the identity providers. *

*/ private java.util.List logoutURLs; /** *

* 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. *

*/ private String defaultRedirectURI; /** *

* 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. *

*/ private java.util.List allowedOAuthFlows; /** *

* 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. *

*/ private java.util.List allowedOAuthScopes; /** *

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

*/ private Boolean allowedOAuthFlowsUserPoolClient; /** *

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

* *

* Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

*
*/ private AnalyticsConfigurationType analyticsConfiguration; /** *

* 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. *

    *
  • *
*

* This setting affects the behavior of following APIs: *

* * *

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

*
*/ private String preventUserExistenceErrors; /** *

* The user pool ID for the user pool where you want to create a user pool client. *

* * @param userPoolId * The user pool ID for the user pool where you want to create a user pool client. */ public void setUserPoolId(String userPoolId) { this.userPoolId = userPoolId; } /** *

* The user pool ID for the user pool where you want to create a user pool client. *

* * @return The user pool ID for the user pool where you want to create a user pool client. */ public String getUserPoolId() { return this.userPoolId; } /** *

* The user pool ID for the user pool where you want to create a user pool client. *

* * @param userPoolId * The user pool ID for the user pool where you want to create a user pool client. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withUserPoolId(String userPoolId) { setUserPoolId(userPoolId); return this; } /** *

* The client name for the user pool client you would like to create. *

* * @param clientName * The client name for the user pool client you would like to create. */ public void setClientName(String clientName) { this.clientName = clientName; } /** *

* The client name for the user pool client you would like to create. *

* * @return The client name for the user pool client you would like to create. */ public String getClientName() { return this.clientName; } /** *

* The client name for the user pool client you would like to create. *

* * @param clientName * The client name for the user pool client you would like to create. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withClientName(String clientName) { setClientName(clientName); return this; } /** *

* Boolean to specify whether you want to generate a secret for the user pool client being created. *

* * @param generateSecret * Boolean to specify whether you want to generate a secret for the user pool client being created. */ public void setGenerateSecret(Boolean generateSecret) { this.generateSecret = generateSecret; } /** *

* Boolean to specify whether you want to generate a secret for the user pool client being created. *

* * @return Boolean to specify whether you want to generate a secret for the user pool client being created. */ public Boolean getGenerateSecret() { return this.generateSecret; } /** *

* Boolean to specify whether you want to generate a secret for the user pool client being created. *

* * @param generateSecret * Boolean to specify whether you want to generate a secret for the user pool client being created. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withGenerateSecret(Boolean generateSecret) { setGenerateSecret(generateSecret); return this; } /** *

* Boolean to specify whether you want to generate a secret for the user pool client being created. *

* * @return Boolean to specify whether you want to generate a secret for the user pool client being created. */ public Boolean isGenerateSecret() { return this.generateSecret; } /** *

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

* * @param refreshTokenValidity * The time limit, in days, after which the refresh token is no longer valid and cannot be used. */ public void setRefreshTokenValidity(Integer refreshTokenValidity) { this.refreshTokenValidity = refreshTokenValidity; } /** *

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

* * @return The time limit, in days, after which the refresh token is no longer valid and cannot be used. */ public Integer getRefreshTokenValidity() { return this.refreshTokenValidity; } /** *

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

* * @param refreshTokenValidity * The time limit, in days, after which the refresh token is no longer valid and cannot be used. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity) { setRefreshTokenValidity(refreshTokenValidity); return this; } /** *

* The read attributes. *

* * @return The read attributes. */ public java.util.List getReadAttributes() { return readAttributes; } /** *

* The read attributes. *

* * @param readAttributes * The read attributes. */ public void setReadAttributes(java.util.Collection readAttributes) { if (readAttributes == null) { this.readAttributes = null; return; } this.readAttributes = new java.util.ArrayList(readAttributes); } /** *

* The read attributes. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setReadAttributes(java.util.Collection)} or {@link #withReadAttributes(java.util.Collection)} if you want * to override the existing values. *

* * @param readAttributes * The read attributes. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withReadAttributes(String... readAttributes) { if (this.readAttributes == null) { setReadAttributes(new java.util.ArrayList(readAttributes.length)); } for (String ele : readAttributes) { this.readAttributes.add(ele); } return this; } /** *

* The read attributes. *

* * @param readAttributes * The read attributes. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withReadAttributes(java.util.Collection readAttributes) { setReadAttributes(readAttributes); return this; } /** *

* The user pool attributes that the app client can write to. *

*

* If your app client allows users to sign in through an identity provider, this array must include all attributes * that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to * your application through an identity provider. If your app client lacks write access to a mapped attribute, * Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. *

* * @return The user pool attributes that the app client can write to.

*

* If your app client allows users to sign in through an identity provider, this array must include all * attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an identity provider. If your app client lacks write access to * a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more * information, see Specifying Identity Provider Attribute Mappings for Your User Pool. */ public java.util.List getWriteAttributes() { return writeAttributes; } /** *

* The user pool attributes that the app client can write to. *

*

* If your app client allows users to sign in through an identity provider, this array must include all attributes * that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to * your application through an identity provider. If your app client lacks write access to a mapped attribute, * Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. *

* * @param writeAttributes * The user pool attributes that the app client can write to.

*

* If your app client allows users to sign in through an identity provider, this array must include all * attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an identity provider. If your app client lacks write access to a * mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more * information, see Specifying Identity Provider Attribute Mappings for Your User Pool. */ public void setWriteAttributes(java.util.Collection writeAttributes) { if (writeAttributes == null) { this.writeAttributes = null; return; } this.writeAttributes = new java.util.ArrayList(writeAttributes); } /** *

* The user pool attributes that the app client can write to. *

*

* If your app client allows users to sign in through an identity provider, this array must include all attributes * that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to * your application through an identity provider. If your app client lacks write access to a mapped attribute, * Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setWriteAttributes(java.util.Collection)} or {@link #withWriteAttributes(java.util.Collection)} if you * want to override the existing values. *

* * @param writeAttributes * The user pool attributes that the app client can write to.

*

* If your app client allows users to sign in through an identity provider, this array must include all * attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an identity provider. If your app client lacks write access to a * mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more * information, see Specifying Identity Provider Attribute Mappings for Your User Pool. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withWriteAttributes(String... writeAttributes) { if (this.writeAttributes == null) { setWriteAttributes(new java.util.ArrayList(writeAttributes.length)); } for (String ele : writeAttributes) { this.writeAttributes.add(ele); } return this; } /** *

* The user pool attributes that the app client can write to. *

*

* If your app client allows users to sign in through an identity provider, this array must include all attributes * that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to * your application through an identity provider. If your app client lacks write access to a mapped attribute, * Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. *

* * @param writeAttributes * The user pool attributes that the app client can write to.

*

* If your app client allows users to sign in through an identity provider, this array must include all * attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an identity provider. If your app client lacks write access to a * mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more * information, see Specifying Identity Provider Attribute Mappings for Your User Pool. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withWriteAttributes(java.util.Collection writeAttributes) { setWriteAttributes(writeAttributes); return this; } /** *

* 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. *

    *
  • *
* * @return 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. *

    *
  • * @see ExplicitAuthFlowsType */ public java.util.List getExplicitAuthFlows() { return explicitAuthFlows; } /** *

    * 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. *

      *
    • *
    * * @param explicitAuthFlows * 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. *

      *
    • * @see ExplicitAuthFlowsType */ public void setExplicitAuthFlows(java.util.Collection explicitAuthFlows) { if (explicitAuthFlows == null) { this.explicitAuthFlows = null; return; } this.explicitAuthFlows = new java.util.ArrayList(explicitAuthFlows); } /** *

      * 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. *

        *
      • *
      *

      * NOTE: This method appends the values to the existing list (if any). Use * {@link #setExplicitAuthFlows(java.util.Collection)} or {@link #withExplicitAuthFlows(java.util.Collection)} if * you want to override the existing values. *

      * * @param explicitAuthFlows * 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. *

        *
      • * @return Returns a reference to this object so that method calls can be chained together. * @see ExplicitAuthFlowsType */ public CreateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows) { if (this.explicitAuthFlows == null) { setExplicitAuthFlows(new java.util.ArrayList(explicitAuthFlows.length)); } for (String ele : explicitAuthFlows) { this.explicitAuthFlows.add(ele); } return this; } /** *

        * 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. *

          *
        • *
        * * @param explicitAuthFlows * 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. *

          *
        • * @return Returns a reference to this object so that method calls can be chained together. * @see ExplicitAuthFlowsType */ public CreateUserPoolClientRequest withExplicitAuthFlows(java.util.Collection explicitAuthFlows) { setExplicitAuthFlows(explicitAuthFlows); return this; } /** *

          * 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. *

            *
          • *
          * * @param explicitAuthFlows * 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. *

            *
          • * @return Returns a reference to this object so that method calls can be chained together. * @see ExplicitAuthFlowsType */ public CreateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows) { java.util.ArrayList explicitAuthFlowsCopy = new java.util.ArrayList(explicitAuthFlows.length); for (ExplicitAuthFlowsType value : explicitAuthFlows) { explicitAuthFlowsCopy.add(value.toString()); } if (getExplicitAuthFlows() == null) { setExplicitAuthFlows(explicitAuthFlowsCopy); } else { getExplicitAuthFlows().addAll(explicitAuthFlowsCopy); } return this; } /** *

            * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and LoginWithAmazon. *

            * * @return A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and * LoginWithAmazon. */ public java.util.List getSupportedIdentityProviders() { return supportedIdentityProviders; } /** *

            * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and LoginWithAmazon. *

            * * @param supportedIdentityProviders * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and * LoginWithAmazon. */ public void setSupportedIdentityProviders(java.util.Collection supportedIdentityProviders) { if (supportedIdentityProviders == null) { this.supportedIdentityProviders = null; return; } this.supportedIdentityProviders = new java.util.ArrayList(supportedIdentityProviders); } /** *

            * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and LoginWithAmazon. *

            *

            * NOTE: This method appends the values to the existing list (if any). Use * {@link #setSupportedIdentityProviders(java.util.Collection)} or * {@link #withSupportedIdentityProviders(java.util.Collection)} if you want to override the existing values. *

            * * @param supportedIdentityProviders * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and * LoginWithAmazon. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withSupportedIdentityProviders(String... supportedIdentityProviders) { if (this.supportedIdentityProviders == null) { setSupportedIdentityProviders(new java.util.ArrayList(supportedIdentityProviders.length)); } for (String ele : supportedIdentityProviders) { this.supportedIdentityProviders.add(ele); } return this; } /** *

            * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and LoginWithAmazon. *

            * * @param supportedIdentityProviders * A list of provider names for the identity providers that are supported on this client. The following are * supported: COGNITO, Facebook, Google and * LoginWithAmazon. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withSupportedIdentityProviders(java.util.Collection supportedIdentityProviders) { setSupportedIdentityProviders(supportedIdentityProviders); return this; } /** *

            * 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. *

            * * @return 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. */ public java.util.List getCallbackURLs() { return callbackURLs; } /** *

            * 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. *

            * * @param callbackURLs * 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. */ public void setCallbackURLs(java.util.Collection callbackURLs) { if (callbackURLs == null) { this.callbackURLs = null; return; } this.callbackURLs = new java.util.ArrayList(callbackURLs); } /** *

            * 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. *

            *

            * NOTE: This method appends the values to the existing list (if any). Use * {@link #setCallbackURLs(java.util.Collection)} or {@link #withCallbackURLs(java.util.Collection)} if you want to * override the existing values. *

            * * @param callbackURLs * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withCallbackURLs(String... callbackURLs) { if (this.callbackURLs == null) { setCallbackURLs(new java.util.ArrayList(callbackURLs.length)); } for (String ele : callbackURLs) { this.callbackURLs.add(ele); } return this; } /** *

            * 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. *

            * * @param callbackURLs * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withCallbackURLs(java.util.Collection callbackURLs) { setCallbackURLs(callbackURLs); return this; } /** *

            * A list of allowed logout URLs for the identity providers. *

            * * @return A list of allowed logout URLs for the identity providers. */ public java.util.List getLogoutURLs() { return logoutURLs; } /** *

            * A list of allowed logout URLs for the identity providers. *

            * * @param logoutURLs * A list of allowed logout URLs for the identity providers. */ public void setLogoutURLs(java.util.Collection logoutURLs) { if (logoutURLs == null) { this.logoutURLs = null; return; } this.logoutURLs = new java.util.ArrayList(logoutURLs); } /** *

            * A list of allowed logout URLs for the identity providers. *

            *

            * NOTE: This method appends the values to the existing list (if any). Use * {@link #setLogoutURLs(java.util.Collection)} or {@link #withLogoutURLs(java.util.Collection)} if you want to * override the existing values. *

            * * @param logoutURLs * A list of allowed logout URLs for the identity providers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withLogoutURLs(String... logoutURLs) { if (this.logoutURLs == null) { setLogoutURLs(new java.util.ArrayList(logoutURLs.length)); } for (String ele : logoutURLs) { this.logoutURLs.add(ele); } return this; } /** *

            * A list of allowed logout URLs for the identity providers. *

            * * @param logoutURLs * A list of allowed logout URLs for the identity providers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withLogoutURLs(java.util.Collection logoutURLs) { setLogoutURLs(logoutURLs); return this; } /** *

            * 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. *

            * * @param defaultRedirectURI * 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. */ public void setDefaultRedirectURI(String defaultRedirectURI) { this.defaultRedirectURI = defaultRedirectURI; } /** *

            * 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. *

            * * @return 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. */ public String getDefaultRedirectURI() { return this.defaultRedirectURI; } /** *

            * 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. *

            * * @param defaultRedirectURI * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withDefaultRedirectURI(String defaultRedirectURI) { setDefaultRedirectURI(defaultRedirectURI); return this; } /** *

            * 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. *

            * * @return 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. * @see OAuthFlowType */ public java.util.List getAllowedOAuthFlows() { return allowedOAuthFlows; } /** *

            * 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. *

            * * @param allowedOAuthFlows * 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. * @see OAuthFlowType */ public void setAllowedOAuthFlows(java.util.Collection allowedOAuthFlows) { if (allowedOAuthFlows == null) { this.allowedOAuthFlows = null; return; } this.allowedOAuthFlows = new java.util.ArrayList(allowedOAuthFlows); } /** *

            * 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. *

            *

            * NOTE: This method appends the values to the existing list (if any). Use * {@link #setAllowedOAuthFlows(java.util.Collection)} or {@link #withAllowedOAuthFlows(java.util.Collection)} if * you want to override the existing values. *

            * * @param allowedOAuthFlows * 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. * @return Returns a reference to this object so that method calls can be chained together. * @see OAuthFlowType */ public CreateUserPoolClientRequest withAllowedOAuthFlows(String... allowedOAuthFlows) { if (this.allowedOAuthFlows == null) { setAllowedOAuthFlows(new java.util.ArrayList(allowedOAuthFlows.length)); } for (String ele : allowedOAuthFlows) { this.allowedOAuthFlows.add(ele); } return this; } /** *

            * 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. *

            * * @param allowedOAuthFlows * 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. * @return Returns a reference to this object so that method calls can be chained together. * @see OAuthFlowType */ public CreateUserPoolClientRequest withAllowedOAuthFlows(java.util.Collection allowedOAuthFlows) { setAllowedOAuthFlows(allowedOAuthFlows); return this; } /** *

            * 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. *

            * * @param allowedOAuthFlows * 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. * @return Returns a reference to this object so that method calls can be chained together. * @see OAuthFlowType */ public CreateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows) { java.util.ArrayList allowedOAuthFlowsCopy = new java.util.ArrayList(allowedOAuthFlows.length); for (OAuthFlowType value : allowedOAuthFlows) { allowedOAuthFlowsCopy.add(value.toString()); } if (getAllowedOAuthFlows() == null) { setAllowedOAuthFlows(allowedOAuthFlowsCopy); } else { getAllowedOAuthFlows().addAll(allowedOAuthFlowsCopy); } return this; } /** *

            * 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. *

            * * @return 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. */ public java.util.List getAllowedOAuthScopes() { return allowedOAuthScopes; } /** *

            * 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. *

            * * @param allowedOAuthScopes * 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. */ public void setAllowedOAuthScopes(java.util.Collection allowedOAuthScopes) { if (allowedOAuthScopes == null) { this.allowedOAuthScopes = null; return; } this.allowedOAuthScopes = new java.util.ArrayList(allowedOAuthScopes); } /** *

            * 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. *

            *

            * NOTE: This method appends the values to the existing list (if any). Use * {@link #setAllowedOAuthScopes(java.util.Collection)} or {@link #withAllowedOAuthScopes(java.util.Collection)} if * you want to override the existing values. *

            * * @param allowedOAuthScopes * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withAllowedOAuthScopes(String... allowedOAuthScopes) { if (this.allowedOAuthScopes == null) { setAllowedOAuthScopes(new java.util.ArrayList(allowedOAuthScopes.length)); } for (String ele : allowedOAuthScopes) { this.allowedOAuthScopes.add(ele); } return this; } /** *

            * 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. *

            * * @param allowedOAuthScopes * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withAllowedOAuthScopes(java.util.Collection allowedOAuthScopes) { setAllowedOAuthScopes(allowedOAuthScopes); return this; } /** *

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

            * * @param allowedOAuthFlowsUserPoolClient * Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user * pools. */ public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient) { this.allowedOAuthFlowsUserPoolClient = allowedOAuthFlowsUserPoolClient; } /** *

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

            * * @return Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user * pools. */ public Boolean getAllowedOAuthFlowsUserPoolClient() { return this.allowedOAuthFlowsUserPoolClient; } /** *

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

            * * @param allowedOAuthFlowsUserPoolClient * Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user * pools. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient) { setAllowedOAuthFlowsUserPoolClient(allowedOAuthFlowsUserPoolClient); return this; } /** *

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

            * * @return Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user * pools. */ public Boolean isAllowedOAuthFlowsUserPoolClient() { return this.allowedOAuthFlowsUserPoolClient; } /** *

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

            * *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

            *
            * * @param analyticsConfiguration * The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

            *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

            */ public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration) { this.analyticsConfiguration = analyticsConfiguration; } /** *

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

            * *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

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

            *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

            */ public AnalyticsConfigurationType getAnalyticsConfiguration() { return this.analyticsConfiguration; } /** *

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

            * *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

            *
            * * @param analyticsConfiguration * The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

            *

            * Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) * us-east-1 Region, regardless of the region in which the user pool resides. *

            * @return Returns a reference to this object so that method calls can be chained together. */ public CreateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration) { setAnalyticsConfiguration(analyticsConfiguration); return this; } /** *

            * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            *
            * * @param preventUserExistenceErrors * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            * @see PreventUserExistenceErrorTypes */ public void setPreventUserExistenceErrors(String preventUserExistenceErrors) { this.preventUserExistenceErrors = preventUserExistenceErrors; } /** *

            * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            *
            * * @return 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            * @see PreventUserExistenceErrorTypes */ public String getPreventUserExistenceErrors() { return this.preventUserExistenceErrors; } /** *

            * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            *
            * * @param preventUserExistenceErrors * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            * @return Returns a reference to this object so that method calls can be chained together. * @see PreventUserExistenceErrorTypes */ public CreateUserPoolClientRequest withPreventUserExistenceErrors(String preventUserExistenceErrors) { setPreventUserExistenceErrors(preventUserExistenceErrors); return this; } /** *

            * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            *
            * * @param preventUserExistenceErrors * 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. *

              *
            • *
            *

            * This setting affects the behavior of following APIs: *

            * * *

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

            * @return Returns a reference to this object so that method calls can be chained together. * @see PreventUserExistenceErrorTypes */ public CreateUserPoolClientRequest withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors) { this.preventUserExistenceErrors = preventUserExistenceErrors.toString(); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getUserPoolId() != null) sb.append("UserPoolId: ").append(getUserPoolId()).append(","); if (getClientName() != null) sb.append("ClientName: ").append(getClientName()).append(","); if (getGenerateSecret() != null) sb.append("GenerateSecret: ").append(getGenerateSecret()).append(","); if (getRefreshTokenValidity() != null) sb.append("RefreshTokenValidity: ").append(getRefreshTokenValidity()).append(","); if (getReadAttributes() != null) sb.append("ReadAttributes: ").append(getReadAttributes()).append(","); if (getWriteAttributes() != null) sb.append("WriteAttributes: ").append(getWriteAttributes()).append(","); if (getExplicitAuthFlows() != null) sb.append("ExplicitAuthFlows: ").append(getExplicitAuthFlows()).append(","); if (getSupportedIdentityProviders() != null) sb.append("SupportedIdentityProviders: ").append(getSupportedIdentityProviders()).append(","); if (getCallbackURLs() != null) sb.append("CallbackURLs: ").append(getCallbackURLs()).append(","); if (getLogoutURLs() != null) sb.append("LogoutURLs: ").append(getLogoutURLs()).append(","); if (getDefaultRedirectURI() != null) sb.append("DefaultRedirectURI: ").append(getDefaultRedirectURI()).append(","); if (getAllowedOAuthFlows() != null) sb.append("AllowedOAuthFlows: ").append(getAllowedOAuthFlows()).append(","); if (getAllowedOAuthScopes() != null) sb.append("AllowedOAuthScopes: ").append(getAllowedOAuthScopes()).append(","); if (getAllowedOAuthFlowsUserPoolClient() != null) sb.append("AllowedOAuthFlowsUserPoolClient: ").append(getAllowedOAuthFlowsUserPoolClient()).append(","); if (getAnalyticsConfiguration() != null) sb.append("AnalyticsConfiguration: ").append(getAnalyticsConfiguration()).append(","); if (getPreventUserExistenceErrors() != null) sb.append("PreventUserExistenceErrors: ").append(getPreventUserExistenceErrors()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateUserPoolClientRequest == false) return false; CreateUserPoolClientRequest other = (CreateUserPoolClientRequest) obj; if (other.getUserPoolId() == null ^ this.getUserPoolId() == null) return false; if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false) return false; if (other.getClientName() == null ^ this.getClientName() == null) return false; if (other.getClientName() != null && other.getClientName().equals(this.getClientName()) == false) return false; if (other.getGenerateSecret() == null ^ this.getGenerateSecret() == null) return false; if (other.getGenerateSecret() != null && other.getGenerateSecret().equals(this.getGenerateSecret()) == false) return false; if (other.getRefreshTokenValidity() == null ^ this.getRefreshTokenValidity() == null) return false; if (other.getRefreshTokenValidity() != null && other.getRefreshTokenValidity().equals(this.getRefreshTokenValidity()) == false) return false; if (other.getReadAttributes() == null ^ this.getReadAttributes() == null) return false; if (other.getReadAttributes() != null && other.getReadAttributes().equals(this.getReadAttributes()) == false) return false; if (other.getWriteAttributes() == null ^ this.getWriteAttributes() == null) return false; if (other.getWriteAttributes() != null && other.getWriteAttributes().equals(this.getWriteAttributes()) == false) return false; if (other.getExplicitAuthFlows() == null ^ this.getExplicitAuthFlows() == null) return false; if (other.getExplicitAuthFlows() != null && other.getExplicitAuthFlows().equals(this.getExplicitAuthFlows()) == false) return false; if (other.getSupportedIdentityProviders() == null ^ this.getSupportedIdentityProviders() == null) return false; if (other.getSupportedIdentityProviders() != null && other.getSupportedIdentityProviders().equals(this.getSupportedIdentityProviders()) == false) return false; if (other.getCallbackURLs() == null ^ this.getCallbackURLs() == null) return false; if (other.getCallbackURLs() != null && other.getCallbackURLs().equals(this.getCallbackURLs()) == false) return false; if (other.getLogoutURLs() == null ^ this.getLogoutURLs() == null) return false; if (other.getLogoutURLs() != null && other.getLogoutURLs().equals(this.getLogoutURLs()) == false) return false; if (other.getDefaultRedirectURI() == null ^ this.getDefaultRedirectURI() == null) return false; if (other.getDefaultRedirectURI() != null && other.getDefaultRedirectURI().equals(this.getDefaultRedirectURI()) == false) return false; if (other.getAllowedOAuthFlows() == null ^ this.getAllowedOAuthFlows() == null) return false; if (other.getAllowedOAuthFlows() != null && other.getAllowedOAuthFlows().equals(this.getAllowedOAuthFlows()) == false) return false; if (other.getAllowedOAuthScopes() == null ^ this.getAllowedOAuthScopes() == null) return false; if (other.getAllowedOAuthScopes() != null && other.getAllowedOAuthScopes().equals(this.getAllowedOAuthScopes()) == false) return false; if (other.getAllowedOAuthFlowsUserPoolClient() == null ^ this.getAllowedOAuthFlowsUserPoolClient() == null) return false; if (other.getAllowedOAuthFlowsUserPoolClient() != null && other.getAllowedOAuthFlowsUserPoolClient().equals(this.getAllowedOAuthFlowsUserPoolClient()) == false) return false; if (other.getAnalyticsConfiguration() == null ^ this.getAnalyticsConfiguration() == null) return false; if (other.getAnalyticsConfiguration() != null && other.getAnalyticsConfiguration().equals(this.getAnalyticsConfiguration()) == false) return false; if (other.getPreventUserExistenceErrors() == null ^ this.getPreventUserExistenceErrors() == null) return false; if (other.getPreventUserExistenceErrors() != null && other.getPreventUserExistenceErrors().equals(this.getPreventUserExistenceErrors()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode()); hashCode = prime * hashCode + ((getClientName() == null) ? 0 : getClientName().hashCode()); hashCode = prime * hashCode + ((getGenerateSecret() == null) ? 0 : getGenerateSecret().hashCode()); hashCode = prime * hashCode + ((getRefreshTokenValidity() == null) ? 0 : getRefreshTokenValidity().hashCode()); hashCode = prime * hashCode + ((getReadAttributes() == null) ? 0 : getReadAttributes().hashCode()); hashCode = prime * hashCode + ((getWriteAttributes() == null) ? 0 : getWriteAttributes().hashCode()); hashCode = prime * hashCode + ((getExplicitAuthFlows() == null) ? 0 : getExplicitAuthFlows().hashCode()); hashCode = prime * hashCode + ((getSupportedIdentityProviders() == null) ? 0 : getSupportedIdentityProviders().hashCode()); hashCode = prime * hashCode + ((getCallbackURLs() == null) ? 0 : getCallbackURLs().hashCode()); hashCode = prime * hashCode + ((getLogoutURLs() == null) ? 0 : getLogoutURLs().hashCode()); hashCode = prime * hashCode + ((getDefaultRedirectURI() == null) ? 0 : getDefaultRedirectURI().hashCode()); hashCode = prime * hashCode + ((getAllowedOAuthFlows() == null) ? 0 : getAllowedOAuthFlows().hashCode()); hashCode = prime * hashCode + ((getAllowedOAuthScopes() == null) ? 0 : getAllowedOAuthScopes().hashCode()); hashCode = prime * hashCode + ((getAllowedOAuthFlowsUserPoolClient() == null) ? 0 : getAllowedOAuthFlowsUserPoolClient().hashCode()); hashCode = prime * hashCode + ((getAnalyticsConfiguration() == null) ? 0 : getAnalyticsConfiguration().hashCode()); hashCode = prime * hashCode + ((getPreventUserExistenceErrors() == null) ? 0 : getPreventUserExistenceErrors().hashCode()); return hashCode; } @Override public CreateUserPoolClientRequest clone() { return (CreateUserPoolClientRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy