Class CfnUserPoolClientProps
Properties for defining a CfnUserPoolClient.
public class CfnUserPoolClientProps : ICfnUserPoolClientProps- Inheritance
-
CfnUserPoolClientProps
- Implements
- Inherited Members
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var cfnUserPoolClientProps = new CfnUserPoolClientProps {
UserPoolId = "userPoolId",
// the properties below are optional
AccessTokenValidity = 123,
AllowedOAuthFlows = new [] { "allowedOAuthFlows" },
AllowedOAuthFlowsUserPoolClient = false,
AllowedOAuthScopes = new [] { "allowedOAuthScopes" },
AnalyticsConfiguration = new AnalyticsConfigurationProperty {
ApplicationArn = "applicationArn",
ApplicationId = "applicationId",
ExternalId = "externalId",
RoleArn = "roleArn",
UserDataShared = false
},
AuthSessionValidity = 123,
CallbackUrLs = new [] { "callbackUrLs" },
ClientName = "clientName",
DefaultRedirectUri = "defaultRedirectUri",
EnablePropagateAdditionalUserContextData = false,
EnableTokenRevocation = false,
ExplicitAuthFlows = new [] { "explicitAuthFlows" },
GenerateSecret = false,
IdTokenValidity = 123,
LogoutUrLs = new [] { "logoutUrLs" },
PreventUserExistenceErrors = "preventUserExistenceErrors",
ReadAttributes = new [] { "readAttributes" },
RefreshTokenValidity = 123,
SupportedIdentityProviders = new [] { "supportedIdentityProviders" },
TokenValidityUnits = new TokenValidityUnitsProperty {
AccessToken = "accessToken",
IdToken = "idToken",
RefreshToken = "refreshToken"
},
WriteAttributes = new [] { "writeAttributes" }
};Remarks
ExampleMetadata: fixture=_generated
Constructors
CfnUserPoolClientProps()
public CfnUserPoolClientProps()Properties
AccessTokenValidity
The access token time limit.
public double? AccessTokenValidity { get; set; }Property Value
Remarks
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.
AllowedOAuthFlows
The allowed OAuth flows.
public string[]? AllowedOAuthFlows { get; set; }Property Value
- string[]
Remarks
AllowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public object? AllowedOAuthFlowsUserPoolClient { get; set; }Property Value
Remarks
AllowedOAuthScopes
The allowed OAuth scopes.
public string[]? AllowedOAuthScopes { get; set; }Property Value
- string[]
Remarks
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
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
public object? AnalyticsConfiguration { get; set; }Property Value
Remarks
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
Amazon Cognito creates a session token for each API request in an authentication flow.
public double? AuthSessionValidity { get; set; }Property Value
Remarks
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
A list of allowed redirect (callback) URLs for the IdPs.
public string[]? CallbackUrLs { get; set; }Property Value
- string[]
Remarks
A redirect URI must:
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
The client name for the user pool client you would like to create.
public string? ClientName { get; set; }Property Value
Remarks
DefaultRedirectUri
The default redirect URI. Must be in the CallbackURLs list.
public string? DefaultRedirectUri { get; set; }Property Value
Remarks
A redirect URI must:
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
Activates the propagation of additional user context data.
public object? EnablePropagateAdditionalUserContextData { get; set; }Property Value
Remarks
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
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken .
public object? EnableTokenRevocation { get; set; }Property Value
Remarks
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
ExplicitAuthFlows
The authentication flows that you want your user pool client to support.
public string[]? ExplicitAuthFlows { get; set; }Property Value
- string[]
Remarks
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 <code>ExplicitAuthFlows</code> , your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code> , <code>ALLOW_USER_SRP_AUTH</code> , and <code>ALLOW_CUSTOM_AUTH</code> .
Valid values include:
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
Boolean to specify whether you want to generate a secret for the user pool client being created.
public object? GenerateSecret { get; set; }Property Value
Remarks
IdTokenValidity
The ID token time limit.
public double? IdTokenValidity { get; set; }Property Value
Remarks
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.
LogoutUrLs
A list of allowed logout URLs for the IdPs.
public string[]? LogoutUrLs { get; set; }Property Value
- string[]
Remarks
PreventUserExistenceErrors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
public string? PreventUserExistenceErrors { get; set; }Property Value
Remarks
When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY , those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
ReadAttributes
The read attributes.
public string[]? ReadAttributes { get; set; }Property Value
- string[]
Remarks
RefreshTokenValidity
The refresh token time limit.
public double? RefreshTokenValidity { get; set; }Property Value
Remarks
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.
SupportedIdentityProviders
A list of provider names for the identity providers (IdPs) that are supported on this client.
public string[]? SupportedIdentityProviders { get; set; }Property Value
- string[]
Remarks
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
The units in which the validity times are represented.
public object? TokenValidityUnits { get; set; }Property Value
Remarks
The default unit for RefreshToken is days, and default for ID and access tokens are hours.
UserPoolId
The user pool ID for the user pool where you want to create a user pool client.
public string UserPoolId { get; set; }Property Value
Remarks
WriteAttributes
The user pool attributes that the app client can write to.
public string[]? WriteAttributes { get; set; }Property Value
- string[]
Remarks
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 .