AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.UserPoolClient

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Create UserPoolClient Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserPoolClient(name: string, args: UserPoolClientArgs, opts?: CustomResourceOptions);

@overload
def UserPoolClient(resource_name: str,
                   args: UserPoolClientArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def UserPoolClient(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   user_pool_id: Optional[str] = None,
                   enable_token_revocation: Optional[bool] = None,
                   auth_session_validity: Optional[int] = None,
                   explicit_auth_flows: Optional[Sequence[str]] = None,
                   id_token_validity: Optional[int] = None,
                   generate_secret: Optional[bool] = None,
                   callback_urls: Optional[Sequence[str]] = None,
                   client_name: Optional[str] = None,
                   default_redirect_uri: Optional[str] = None,
                   enable_propagate_additional_user_context_data: Optional[bool] = None,
                   access_token_validity: Optional[int] = None,
                   allowed_o_auth_scopes: Optional[Sequence[str]] = None,
                   allowed_o_auth_flows_user_pool_client: Optional[bool] = None,
                   analytics_configuration: Optional[UserPoolClientAnalyticsConfigurationArgs] = None,
                   logout_urls: Optional[Sequence[str]] = None,
                   prevent_user_existence_errors: Optional[str] = None,
                   read_attributes: Optional[Sequence[str]] = None,
                   refresh_token_validity: Optional[int] = None,
                   supported_identity_providers: Optional[Sequence[str]] = None,
                   token_validity_units: Optional[UserPoolClientTokenValidityUnitsArgs] = None,
                   allowed_o_auth_flows: Optional[Sequence[str]] = None,
                   write_attributes: Optional[Sequence[str]] = None)

func NewUserPoolClient(ctx *Context, name string, args UserPoolClientArgs, opts ...ResourceOption) (*UserPoolClient, error)

public UserPoolClient(string name, UserPoolClientArgs args, CustomResourceOptions? opts = null)

public UserPoolClient(String name, UserPoolClientArgs args)
public UserPoolClient(String name, UserPoolClientArgs args, CustomResourceOptions options)

type: aws-native:cognito:UserPoolClient
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

UserPoolClient Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserPoolClient resource accepts the following input properties:

UserPoolId string

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

AccessTokenValidity int

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 List<string>

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 bool

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the AWS CLI or SDKs, it defaults to false .

AllowedOAuthScopes List<string>

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.

AnalyticsConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolClientAnalyticsConfiguration

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

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS 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 int

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 List<string>

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.

ClientName string

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

DefaultRedirectUri string

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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 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 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 List<string>

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 bool

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

IdTokenValidity int

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 IdTokenValidity 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 List<string>

A list of allowed logout URLs for the IdPs.

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 early behavior of Amazon Cognito where user existence related errors aren't prevented.

Defaults to LEGACY when you don't provide a value.

ReadAttributes List<string>

The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified , phone_number_verified , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of read attributes.

RefreshTokenValidity int

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 List<string>

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 Pulumi.AwsNative.Cognito.Inputs.UserPoolClientTokenValidityUnits

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 List<string>

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.

When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.

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 string

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

AccessTokenValidity int

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 []string

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 bool

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

AllowedOAuthScopes []string

AnalyticsConfiguration UserPoolClientAnalyticsConfigurationArgs

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

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS 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 int

CallbackUrls []string

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.

ClientName string

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

DefaultRedirectUri string

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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 bool

EnableTokenRevocation 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 []string

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.

GenerateSecret bool

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

IdTokenValidity int

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 IdTokenValidity 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 []string

A list of allowed logout URLs for the IdPs.

PreventUserExistenceErrors string

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.

Defaults to LEGACY when you don't provide a value.

ReadAttributes []string

RefreshTokenValidity int

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.

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

SupportedIdentityProviders []string

TokenValidityUnits UserPoolClientTokenValidityUnitsArgs

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 []string

userPoolId String

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

accessTokenValidity Integer

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 List<String>

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 Boolean

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

allowedOAuthScopes List<String>

analyticsConfiguration UserPoolClientAnalyticsConfiguration

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

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS 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 Integer

callbackUrls List<String>

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.

clientName String

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

defaultRedirectUri String

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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 Boolean

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

explicitAuthFlows List<String>

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.

generateSecret Boolean

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

idTokenValidity Integer

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 IdTokenValidity 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 List<String>

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors String

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.

Defaults to LEGACY when you don't provide a value.

readAttributes List<String>

refreshTokenValidity Integer

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.

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

supportedIdentityProviders List<String>

tokenValidityUnits UserPoolClientTokenValidityUnits

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 List<String>

userPoolId string

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

accessTokenValidity number

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 string[]

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 boolean

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

allowedOAuthScopes string[]

analyticsConfiguration UserPoolClientAnalyticsConfiguration

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

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS 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 number

callbackUrls string[]

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.

clientName string

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

defaultRedirectUri string

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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 boolean

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

explicitAuthFlows string[]

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.

generateSecret boolean

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

idTokenValidity number

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 IdTokenValidity 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 string[]

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors string

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.

Defaults to LEGACY when you don't provide a value.

readAttributes string[]

refreshTokenValidity number

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.

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

supportedIdentityProviders string[]

tokenValidityUnits UserPoolClientTokenValidityUnits

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 string[]

user_pool_id str

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

access_token_validity int

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.

allowed_o_auth_flows Sequence[str]

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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.

allowed_o_auth_flows_user_pool_client bool

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

allowed_o_auth_scopes Sequence[str]

analytics_configuration UserPoolClientAnalyticsConfigurationArgs

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

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

auth_session_validity int

callback_urls Sequence[str]

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.

client_name str

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

default_redirect_uri str

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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

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

enable_propagate_additional_user_context_data bool

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

explicit_auth_flows Sequence[str]

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.

generate_secret bool

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

id_token_validity int

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

logout_urls Sequence[str]

A list of allowed logout URLs for the IdPs.

prevent_user_existence_errors str

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.

Defaults to LEGACY when you don't provide a value.

read_attributes Sequence[str]

refresh_token_validity int

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.

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

supported_identity_providers Sequence[str]

token_validity_units UserPoolClientTokenValidityUnitsArgs

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.

write_attributes Sequence[str]

userPoolId String

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

accessTokenValidity Number

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 List<String>

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 Boolean

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs : Callback URLs.
LogoutURLs : Sign-out redirect URLs.
AllowedOAuthScopes : OAuth 2.0 scopes.
AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

allowedOAuthScopes List<String>

analyticsConfiguration Property Map

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

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS 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 Number

callbackUrls List<String>

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.

clientName String

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

defaultRedirectUri String

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI .

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 Boolean

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

explicitAuthFlows List<String>

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.

generateSecret Boolean

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

idTokenValidity Number

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 IdTokenValidity 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 List<String>

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors String

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.

Defaults to LEGACY when you don't provide a value.

readAttributes List<String>

refreshTokenValidity Number

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.

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

supportedIdentityProviders List<String>

tokenValidityUnits Property Map

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 List<String>

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPoolClient resource produces the following output properties:

ClientId string: The ID of the app client, for example 1example23456789 .
ClientSecret string
Id string: The provider-assigned unique ID for this managed resource.
Name string

ClientId string: The ID of the app client, for example 1example23456789 .
ClientSecret string
Id string: The provider-assigned unique ID for this managed resource.
Name string

clientId String: The ID of the app client, for example 1example23456789 .
clientSecret String
id String: The provider-assigned unique ID for this managed resource.
name String

clientId string: The ID of the app client, for example 1example23456789 .
clientSecret string
id string: The provider-assigned unique ID for this managed resource.
name string

client_id str: The ID of the app client, for example 1example23456789 .
client_secret str
id str: The provider-assigned unique ID for this managed resource.
name str

clientId String: The ID of the app client, for example 1example23456789 .
clientSecret String
id String: The provider-assigned unique ID for this managed resource.
name String

Supporting Types

UserPoolClientAnalyticsConfiguration, UserPoolClientAnalyticsConfigurationArgs

ApplicationArn string: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
ApplicationId string: Your Amazon Pinpoint project ID.
ExternalId string: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
RoleArn string: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
UserDataShared bool: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

ApplicationArn string: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
ApplicationId string: Your Amazon Pinpoint project ID.
ExternalId string: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
RoleArn string: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
UserDataShared bool: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

applicationArn String: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
applicationId String: Your Amazon Pinpoint project ID.
externalId String: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
roleArn String: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
userDataShared Boolean: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

applicationArn string: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
applicationId string: Your Amazon Pinpoint project ID.
externalId string: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
roleArn string: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
userDataShared boolean: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

application_arn str: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
application_id str: Your Amazon Pinpoint project ID.
external_id str: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
role_arn str: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
user_data_shared bool: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

applicationArn String: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
applicationId String: Your Amazon Pinpoint project ID.
externalId String: The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
roleArn String: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
userDataShared Boolean: If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

UserPoolClientTokenValidityUnits, UserPoolClientTokenValidityUnitsArgs

AccessToken string: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
IdToken string: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
RefreshToken string: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

AccessToken string: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
IdToken string: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
RefreshToken string: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

accessToken String: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
idToken String: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
refreshToken String: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

accessToken string: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
idToken string: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
refreshToken string: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

access_token str: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
id_token str: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
refresh_token str: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

accessToken String: A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours . AccessTokenValidity duration can range from five minutes to one day.
idToken String: A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours . IdTokenValidity duration can range from five minutes to one day.
refreshToken String: A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days . RefreshTokenValidity duration can range from 60 minutes to 10 years.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.UserPoolClient

On this page

On this page

Create UserPoolClient Resource

Constructor syntax

Parameters

UserPoolClient Resource Properties

Inputs

Outputs

Supporting Types

UserPoolClientAnalyticsConfiguration, UserPoolClientAnalyticsConfigurationArgs

UserPoolClientTokenValidityUnits, UserPoolClientTokenValidityUnitsArgs

Package Details

On this page

On this page