Amazonka.CognitoIdentityProvider.CreateUserPoolClient

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.

Creating a Request

data CreateUserPoolClient

Represents the request to create a user pool client.

See: newCreateUserPoolClient smart constructor.

Constructors

CreateUserPoolClient'

Fields

• accessTokenValidity :: Maybe Natural

  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.

  If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

• allowedOAuthFlows :: Maybe [OAuthFlowType]

  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.

• allowedOAuthFlowsUserPoolClient :: Maybe Bool

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

• allowedOAuthScopes :: Maybe [Text]

  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.

• analyticsConfiguration :: Maybe AnalyticsConfigurationType

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

  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.

• authSessionValidity :: Maybe Natural

  Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

• callbackURLs :: Maybe [Text]

  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.

• defaultRedirectURI :: Maybe Text

  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.

• enablePropagateAdditionalUserContextData :: Maybe Bool

  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.

• enableTokenRevocation :: Maybe Bool

  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.

• explicitAuthFlows :: Maybe [ExplicitAuthFlowsType]

  The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

  If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

  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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
  • 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.

  In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

• generateSecret :: Maybe Bool

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

• idTokenValidity :: Maybe Natural

  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.

  If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

• logoutURLs :: Maybe [Text]

  A list of allowed logout URLs for the IdPs.

• preventUserExistenceErrors :: Maybe PreventUserExistenceErrorTypes

  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.
• readAttributes :: Maybe [Text]

  The read attributes.

• refreshTokenValidity :: Maybe Natural

  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.

  If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

• supportedIdentityProviders :: Maybe [Text]

  A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

• tokenValidityUnits :: Maybe TokenValidityUnitsType

  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.

• writeAttributes :: Maybe [Text]

  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.

• userPoolId :: Text

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

• clientName :: Text

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

Instances

ToJSON CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

toJSON :: CreateUserPoolClient -> Value

toEncoding :: CreateUserPoolClient -> Encoding

toJSONList :: [CreateUserPoolClient] -> Value

toEncodingList :: [CreateUserPoolClient] -> Encoding

ToHeaders CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

toHeaders :: CreateUserPoolClient -> [Header]

ToPath CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

toPath :: CreateUserPoolClient -> ByteString

ToQuery CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

toQuery :: CreateUserPoolClient -> QueryString

AWSRequest CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Associated Types

type AWSResponse CreateUserPoolClient

Methods

request :: (Service -> Service) -> CreateUserPoolClient -> Request CreateUserPoolClient

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUserPoolClient -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUserPoolClient)))

Generic CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Associated Types

type Rep CreateUserPoolClient :: Type -> Type

Methods

from :: CreateUserPoolClient -> Rep CreateUserPoolClient x

to :: Rep CreateUserPoolClient x -> CreateUserPoolClient

Read CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

readsPrec :: Int -> ReadS CreateUserPoolClient

readList :: ReadS [CreateUserPoolClient]

readPrec :: ReadPrec CreateUserPoolClient

readListPrec :: ReadPrec [CreateUserPoolClient]

Show CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

showsPrec :: Int -> CreateUserPoolClient -> ShowS

show :: CreateUserPoolClient -> String

showList :: [CreateUserPoolClient] -> ShowS

NFData CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

rnf :: CreateUserPoolClient -> ()

Eq CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

(==) :: CreateUserPoolClient -> CreateUserPoolClient -> Bool

(/=) :: CreateUserPoolClient -> CreateUserPoolClient -> Bool

Hashable CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

hashWithSalt :: Int -> CreateUserPoolClient -> Int

hash :: CreateUserPoolClient -> Int

type AWSResponse CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

type AWSResponse CreateUserPoolClient = CreateUserPoolClientResponse

type Rep CreateUserPoolClient

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

type Rep CreateUserPoolClient = D1 ('MetaData "CreateUserPoolClient" "Amazonka.CognitoIdentityProvider.CreateUserPoolClient" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateUserPoolClient'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessTokenValidity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "allowedOAuthFlows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OAuthFlowType]))) :*: (S1 ('MetaSel ('Just "allowedOAuthFlowsUserPoolClient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "allowedOAuthScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "analyticsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsConfigurationType))))) :*: ((S1 ('MetaSel ('Just "authSessionValidity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "callbackURLs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "defaultRedirectURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "enablePropagateAdditionalUserContextData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "enableTokenRevocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "explicitAuthFlows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExplicitAuthFlowsType])))))) :*: (((S1 ('MetaSel ('Just "generateSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "idTokenValidity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "logoutURLs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "preventUserExistenceErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PreventUserExistenceErrorTypes)) :*: S1 ('MetaSel ('Just "readAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "refreshTokenValidity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "supportedIdentityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tokenValidityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TokenValidityUnitsType)))) :*: (S1 ('MetaSel ('Just "writeAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateUserPoolClient

Arguments

:: Text

CreateUserPoolClient

-> Text

CreateUserPoolClient

-> CreateUserPoolClient

Create a value of CreateUserPoolClient with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateUserPoolClient, createUserPoolClient_accessTokenValidity - 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.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

CreateUserPoolClient, createUserPoolClient_allowedOAuthFlows - 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.

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

CreateUserPoolClient, createUserPoolClient_allowedOAuthScopes - 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.

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

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.

CreateUserPoolClient, createUserPoolClient_authSessionValidity - Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

CreateUserPoolClient, createUserPoolClient_callbackURLs - 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.

CreateUserPoolClient, createUserPoolClient_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.

CreateUserPoolClient, createUserPoolClient_enablePropagateAdditionalUserContextData - 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.

CreateUserPoolClient, createUserPoolClient_enableTokenRevocation - 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.

CreateUserPoolClient, createUserPoolClient_explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
• 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.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

$sel:generateSecret:CreateUserPoolClient', createUserPoolClient_generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.

CreateUserPoolClient, createUserPoolClient_idTokenValidity - 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.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

CreateUserPoolClient, createUserPoolClient_logoutURLs - A list of allowed logout URLs for the IdPs.

CreateUserPoolClient, createUserPoolClient_preventUserExistenceErrors - 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.

CreateUserPoolClient, createUserPoolClient_readAttributes - The read attributes.

CreateUserPoolClient, createUserPoolClient_refreshTokenValidity - 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.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

CreateUserPoolClient, createUserPoolClient_supportedIdentityProviders - A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

CreateUserPoolClient, createUserPoolClient_tokenValidityUnits - 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.

CreateUserPoolClient, createUserPoolClient_writeAttributes - 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.

CreateUserPoolClient, createUserPoolClient_userPoolId - The user pool ID for the user pool where you want to create a user pool client.

CreateUserPoolClient, createUserPoolClient_clientName - The client name for the user pool client you would like to create.

Request Lenses

createUserPoolClient_accessTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural)

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.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

createUserPoolClient_allowedOAuthFlows :: Lens' CreateUserPoolClient (Maybe [OAuthFlowType])

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.

createUserPoolClient_allowedOAuthFlowsUserPoolClient :: Lens' CreateUserPoolClient (Maybe Bool)

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

createUserPoolClient_allowedOAuthScopes :: Lens' CreateUserPoolClient (Maybe [Text])

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.

createUserPoolClient_analyticsConfiguration :: Lens' CreateUserPoolClient (Maybe AnalyticsConfigurationType)

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

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.

createUserPoolClient_authSessionValidity :: Lens' CreateUserPoolClient (Maybe Natural)

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

createUserPoolClient_callbackURLs :: Lens' CreateUserPoolClient (Maybe [Text])

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.

createUserPoolClient_defaultRedirectURI :: Lens' CreateUserPoolClient (Maybe Text)

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.

createUserPoolClient_enablePropagateAdditionalUserContextData :: Lens' CreateUserPoolClient (Maybe Bool)

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.

createUserPoolClient_enableTokenRevocation :: Lens' CreateUserPoolClient (Maybe Bool)

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.

createUserPoolClient_explicitAuthFlows :: Lens' CreateUserPoolClient (Maybe [ExplicitAuthFlowsType])

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
• 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.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

createUserPoolClient_generateSecret :: Lens' CreateUserPoolClient (Maybe Bool)

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

createUserPoolClient_idTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural)

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.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

createUserPoolClient_logoutURLs :: Lens' CreateUserPoolClient (Maybe [Text])

A list of allowed logout URLs for the IdPs.

createUserPoolClient_preventUserExistenceErrors :: Lens' CreateUserPoolClient (Maybe PreventUserExistenceErrorTypes)

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.

createUserPoolClient_readAttributes :: Lens' CreateUserPoolClient (Maybe [Text])

The read attributes.

createUserPoolClient_refreshTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural)

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.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

createUserPoolClient_supportedIdentityProviders :: Lens' CreateUserPoolClient (Maybe [Text])

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

createUserPoolClient_tokenValidityUnits :: Lens' CreateUserPoolClient (Maybe TokenValidityUnitsType)

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.

createUserPoolClient_writeAttributes :: Lens' CreateUserPoolClient (Maybe [Text])

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.

createUserPoolClient_userPoolId :: Lens' CreateUserPoolClient Text

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

createUserPoolClient_clientName :: Lens' CreateUserPoolClient Text

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

Destructuring the Response

data CreateUserPoolClientResponse

Represents the response from the server to create a user pool client.

See: newCreateUserPoolClientResponse smart constructor.

Constructors

CreateUserPoolClientResponse'

Fields

• userPoolClient :: Maybe UserPoolClientType

  The user pool client that was just created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateUserPoolClientResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Associated Types

type Rep CreateUserPoolClientResponse :: Type -> Type

Methods

from :: CreateUserPoolClientResponse -> Rep CreateUserPoolClientResponse x

to :: Rep CreateUserPoolClientResponse x -> CreateUserPoolClientResponse

Show CreateUserPoolClientResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

showsPrec :: Int -> CreateUserPoolClientResponse -> ShowS

show :: CreateUserPoolClientResponse -> String

showList :: [CreateUserPoolClientResponse] -> ShowS

NFData CreateUserPoolClientResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

rnf :: CreateUserPoolClientResponse -> ()

Eq CreateUserPoolClientResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

Methods

(==) :: CreateUserPoolClientResponse -> CreateUserPoolClientResponse -> Bool

(/=) :: CreateUserPoolClientResponse -> CreateUserPoolClientResponse -> Bool

type Rep CreateUserPoolClientResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserPoolClient

type Rep CreateUserPoolClientResponse = D1 ('MetaData "CreateUserPoolClientResponse" "Amazonka.CognitoIdentityProvider.CreateUserPoolClient" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateUserPoolClientResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolClient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolClientType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserPoolClientResponse

Arguments

:: Int

$sel:httpStatus:CreateUserPoolClientResponse'

-> CreateUserPoolClientResponse

Create a value of CreateUserPoolClientResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userPoolClient:CreateUserPoolClientResponse', createUserPoolClientResponse_userPoolClient - The user pool client that was just created.

$sel:httpStatus:CreateUserPoolClientResponse', createUserPoolClientResponse_httpStatus - The response's http status code.

Response Lenses

createUserPoolClientResponse_userPoolClient :: Lens' CreateUserPoolClientResponse (Maybe UserPoolClientType)

The user pool client that was just created.

createUserPoolClientResponse_httpStatus :: Lens' CreateUserPoolClientResponse Int

The response's http status code.