create-user-pool-client¶

Description¶

Creates the user pool client.

When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken .

Synopsis¶

  create-user-pool-client
--user-pool-id <value>
--client-name <value>
[--generate-secret | --no-generate-secret]
[--refresh-token-validity <value>]
[--access-token-validity <value>]
[--id-token-validity <value>]
[--token-validity-units <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>]
[--enable-token-revocation | --no-enable-token-revocation]
[--enable-propagate-additional-user-context-data | --no-enable-propagate-additional-user-context-data]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--user-pool-id (string)

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

--client-name (string)

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

--generate-secret | --no-generate-secret (boolean)

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

--refresh-token-validity (integer)

The refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days , your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can’t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

--access-token-validity (integer)

The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit for AccessTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

--id-token-validity (integer)

The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit for IdTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

--token-validity-units (structure)

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

AccessToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.

IdToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.

RefreshToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.

Shorthand Syntax:

AccessToken=string,IdToken=string,RefreshToken=string

JSON Syntax:

{
  "AccessToken": "seconds"|"minutes"|"hours"|"days",
  "IdToken": "seconds"|"minutes"|"hours"|"days",
  "RefreshToken": "seconds"|"minutes"|"hours"|"days"
}

--read-attributes (list)

The read attributes.

(string)

Syntax:

"string" "string" ...

--write-attributes (list)

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

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .

(string)

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 no longer supported, in favor of new names with the ALLOW_ prefix.

Note

Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication.

ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In this flow, Amazon 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.

If you don’t specify a value for ExplicitAuthFlows , your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.

(string)

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 IdPs that this client supports. The following are supported: COGNITO , Facebook , Google LoginWithAmazon , and the names of your own SAML and OIDC providers.

(string)

Syntax:

"string" "string" ...

--callback-urls (list)

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

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)

Syntax:

"string" "string" ...

--logout-urls (list)

A list of allowed logout URLs for the IdPs.

(string)

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)

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  code
  implicit
  client_credentials

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

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

(string)

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 Amazon Cognito user pools.

--analytics-configuration (structure)

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

Note

In Amazon Web Services Regions where Amazon Pinpoint isn’t available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

ApplicationId -> (string)

The application ID for an Amazon Pinpoint application.

ApplicationArn -> (string)

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

RoleArn -> (string)

The ARN of an Identity and Access Management 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 includes user data in the events that it publishes to Amazon Pinpoint analytics.

Shorthand Syntax:

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

JSON Syntax:

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

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

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn’t exist in the user pool. When set to ENABLED and the user doesn’t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY , those APIs return a UserNotFoundException exception if the user doesn’t exist in the user pool.

Valid values include:

ENABLED - This prevents user existence-related errors.

LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren’t prevented.

Possible values:

LEGACY

ENABLED

--enable-token-revocation | --no-enable-token-revocation (boolean)

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken .

If you don’t include this parameter, token revocation is automatically activated for the new user pool client.

--enable-propagate-additional-user-context-data | --no-enable-propagate-additional-user-context-data (boolean)

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can’t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 create a user pool client

This example creates a new user pool client with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH.

Command:

aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa  --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH"

Output:

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "MyNewClient",
      "ClientId": "6p3bs000no6a4ue1idruvd05ad",
      "LastModifiedDate": 1548697449.497,
      "CreationDate": 1548697449.497,
      "RefreshTokenValidity": 30,
      "ExplicitAuthFlows": [
          "USER_PASSWORD_AUTH",
          "ADMIN_NO_SRP_AUTH"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

Output¶

UserPoolClient -> (structure)

The user pool client that was just created.

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 refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit for RefreshTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days , your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can’t set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

AccessTokenValidity -> (integer)

The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit for AccessTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

IdTokenValidity -> (integer)

The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit for IdTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

TokenValidityUnits -> (structure)

The time units used to specify the token validity times of each token type: ID, access, and refresh.

AccessToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.

IdToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.

RefreshToken -> (string)

A time unit of seconds , minutes , hours , or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.

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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication.

ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In this flow, Amazon 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 IdPs that this client supports. The following are supported: COGNITO , Facebook , Google LoginWithAmazon , and the names of your own SAML and OIDC providers.

(string)

CallbackURLs -> (list)

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

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

(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)

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

(string)

AllowedOAuthScopes -> (list)

The OAuth scopes that your app client supports. Possible values that OAuth provides are phone , email , openid , and profile . Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin . Amazon Cognito also supports custom scopes that you create in Resource Servers.

(string)

AllowedOAuthFlowsUserPoolClient -> (boolean)

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

AnalyticsConfiguration -> (structure)

The Amazon Pinpoint analytics configuration for the user pool client.

Note

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.

ApplicationId -> (string)

The application ID for an Amazon Pinpoint application.

ApplicationArn -> (string)

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

RoleArn -> (string)

The ARN of an Identity and Access Management 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 includes user data in the events that it publishes to Amazon Pinpoint analytics.

PreventUserExistenceErrors -> (string)

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn’t exist in the user pool. When set to ENABLED and the user doesn’t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY , those APIs return a UserNotFoundException exception if the user doesn’t exist in the user pool.

Valid values include:

ENABLED - This prevents user existence-related errors.

LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren’t prevented.

EnableTokenRevocation -> (boolean)

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken .

EnablePropagateAdditionalUserContextData -> (boolean)

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.

When EnablePropagateAdditionalUserContextData is false, you can’t send your user’s source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn’t affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge .

You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests .

Table of Contents

Feedback

User Guide

create-user-pool-client¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶