Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

update-user-pool-client

Description

Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with .

Warning

If you don't provide a value for an attribute, it will be set to the default value.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-user-pool-client
--user-pool-id <value>
--client-id <value>
[--client-name <value>]
[--refresh-token-validity <value>]
[--read-attributes <value>]
[--write-attributes <value>]
[--explicit-auth-flows <value>]
[--supported-identity-providers <value>]
[--callback-urls <value>]
[--logout-urls <value>]
[--default-redirect-uri <value>]
[--allowed-o-auth-flows <value>]
[--allowed-o-auth-scopes <value>]
[--allowed-o-auth-flows-user-pool-client | --no-allowed-o-auth-flows-user-pool-client]
[--analytics-configuration <value>]
[--prevent-user-existence-errors <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

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

--client-id (string)

The ID of the client associated with the user pool.

--client-name (string)

The client name from the update user pool client request.

--refresh-token-validity (integer)

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

--read-attributes (list)

The read-only attributes of the user pool.

Syntax:

"string" "string" ...

--write-attributes (list)

The writeable attributes of the user pool.

Syntax:

"string" "string" ...

--explicit-auth-flows (list)

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.

Syntax:

"string" "string" ...

Where valid values are:
  ADMIN_NO_SRP_AUTH
  CUSTOM_AUTH_FLOW_ONLY
  USER_PASSWORD_AUTH
  ALLOW_ADMIN_USER_PASSWORD_AUTH
  ALLOW_CUSTOM_AUTH
  ALLOW_USER_PASSWORD_AUTH
  ALLOW_USER_SRP_AUTH
  ALLOW_REFRESH_TOKEN_AUTH

--supported-identity-providers (list)

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

Syntax:

"string" "string" ...

--callback-urls (list)

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.

Syntax:

"string" "string" ...

--logout-urls (list)

A list of allowed logout URLs for the identity providers.

Syntax:

"string" "string" ...

--default-redirect-uri (string)

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.

--allowed-o-auth-flows (list)

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.

Syntax:

"string" "string" ...

Where valid values are:
  code
  implicit
  client_credentials

--allowed-o-auth-scopes (list)

A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and "Cognito" . In addition to these values, custom scopes created in Resource Servers are also supported.

Syntax:

"string" "string" ...

--allowed-o-auth-flows-user-pool-client | --no-allowed-o-auth-flows-user-pool-client (boolean)

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

--analytics-configuration (structure)

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

Shorthand Syntax:

ApplicationId=string,RoleArn=string,ExternalId=string,UserDataShared=boolean

JSON Syntax:

{
  "ApplicationId": "string",
  "RoleArn": "string",
  "ExternalId": "string",
  "UserDataShared": true|false
}

--prevent-user-existence-errors (string)

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:

  • AdminInitiateAuth
  • AdminRespondToAuthChallenge
  • InitiateAuth
  • RespondToAuthChallenge
  • ForgotPassword
  • ConfirmForgotPassword
  • ConfirmSignUp
  • ResendConfirmationCode

Note

After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Possible values:

  • LEGACY
  • ENABLED

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a user pool client

This example updates the name of a user pool client. It also adds a writeable attribute "nickname".

Command:

aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname"

Output:

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "NewClientName",
      "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
      "LastModifiedDate": 1548802761.334,
      "CreationDate": 1548178931.258,
      "RefreshTokenValidity": 30,
      "WriteAttributes": [
          "nickname"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

Output

UserPoolClient -> (structure)

The user pool client value from the response from the server when an update user pool client request is made.

UserPoolId -> (string)

The user pool ID for the user pool client.

ClientName -> (string)

The client name from the user pool request of the client type.

ClientId -> (string)

The ID of the client associated with the user pool.

ClientSecret -> (string)

The client secret from the user pool request of the client type.

LastModifiedDate -> (timestamp)

The date the user pool client was last modified.

CreationDate -> (timestamp)

The date the user pool client was created.

RefreshTokenValidity -> (integer)

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

ReadAttributes -> (list)

The Read-only attributes.

(string)

WriteAttributes -> (list)

The writeable attributes.

(string)

ExplicitAuthFlows -> (list)

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.

(string)

SupportedIdentityProviders -> (list)

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

(string)

CallbackURLs -> (list)

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.

(string)

LogoutURLs -> (list)

A list of allowed logout URLs for the identity providers.

(string)

DefaultRedirectURI -> (string)

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.

AllowedOAuthFlows -> (list)

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 token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

(string)

AllowedOAuthScopes -> (list)

A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and "Cognito" . In addition to these values, custom scopes created in Resource Servers are also supported.

(string)

AllowedOAuthFlowsUserPoolClient -> (boolean)

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

AnalyticsConfiguration -> (structure)

The Amazon Pinpoint analytics configuration for the user pool client.

ApplicationId -> (string)

The application ID for an Amazon Pinpoint application.

RoleArn -> (string)

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

ExternalId -> (string)

The external ID.

UserDataShared -> (boolean)

If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

PreventUserExistenceErrors -> (string)

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:

  • AdminInitiateAuth
  • AdminRespondToAuthChallenge
  • InitiateAuth
  • RespondToAuthChallenge
  • ForgotPassword
  • ConfirmForgotPassword
  • ConfirmSignUp
  • ResendConfirmationCode

Note

After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.