Interface ICfnUserPoolClientProps
Properties for defining a CfnUserPoolClient.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnUserPoolClientPropsSyntax (vb)
Public Interface ICfnUserPoolClientPropsRemarks
ExampleMetadata: fixture=_generated
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" }
};Synopsis
Properties
| Access |
The access token time limit. |
| Allowed |
The OAuth grant types that you want your app client to generate for clients in managed login authentication. |
| Allowed |
Set to |
| Allowed |
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. |
| Analytics |
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. |
| Auth |
Amazon Cognito creates a session token for each API request in an authentication flow. |
| Callback |
A list of allowed redirect, or callback, URLs for managed login authentication. |
| Client |
A friendly name for the app client that you want to create. |
| Default |
The default redirect URI. |
| Enable |
When |
| Enable |
Activates or deactivates token revocation. |
| Explicit |
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. |
| Generate |
When |
| Id |
The ID token time limit. |
| Logout |
A list of allowed logout URLs for managed login authentication. |
| Prevent |
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. |
| Read |
The list of user attributes that you want your app client to have read access to. |
| Refresh |
The refresh token time limit. |
| Supported |
A list of provider names for the identity providers (IdPs) that are supported on this client. |
| Token |
The units that validity times are represented in. |
| User |
The ID of the user pool where you want to create an app client. |
| Write |
The list of user attributes that you want your app client to have write access to. |
Properties
AccessTokenValidity
The access token time limit.
virtual Nullable<double> AccessTokenValidity { get; }Property Value
System.
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. 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
The OAuth grant types that you want your app client to generate for clients in managed login authentication.
virtual string[] AllowedOAuthFlows { get; }Property Value
System.
Remarks
To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.
AllowedOAuthFlowsUserPoolClient
Set to true to use OAuth 2.0 authorization server features in your app client.
virtual object AllowedOAuthFlowsUserPoolClient { get; }Property Value
System.
Remarks
This parameter must have a value of true before you can configure the following features in your app client.
To use authorization server 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 . When false , only SDK-based API sign-in is permitted.
AllowedOAuthScopes
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
virtual string[] AllowedOAuthScopes { get; }Property Value
System.
Remarks
Scopes govern access control to user pool self-service API operations, user data from the userInfo endpoint, and third-party APIs. Scope values include phone , email , openid , and profile . The aws.cognito.signin.user.admin scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
AnalyticsConfiguration
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
virtual object AnalyticsConfiguration { get; }Property Value
System.
Remarks
In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics .
AuthSessionValidity
Amazon Cognito creates a session token for each API request in an authentication flow.
virtual Nullable<double> AuthSessionValidity { get; }Property Value
System.
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, or callback, URLs for managed login authentication.
virtual string[] CallbackUrLs { get; }Property Value
System.
Remarks
These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.
A redirect URI must meet the following requirements:
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
A friendly name for the app client that you want to create.
virtual string ClientName { get; }Property Value
System.
Remarks
DefaultRedirectUri
The default redirect URI.
virtual string DefaultRedirectUri { get; }Property Value
System.
Remarks
In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
EnablePropagateAdditionalUserContextData
When true , your application can include additional UserContextData in authentication requests.
virtual object EnablePropagateAdditionalUserContextData { get; }Property Value
System.
Remarks
This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
EnableTokenRevocation
Activates or deactivates token revocation.
virtual object EnableTokenRevocation { get; }Property Value
System.
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. 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.
virtual string[] ExplicitAuthFlows { get; }Property Value
System.
Remarks
If you don't specify a value for ExplicitAuthFlows , your app client supports ALLOW_REFRESH_TOKEN_AUTH , ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH .
The values for authentication flow options include the following.
To activate this setting, your user pool must be in the Essentials tier or higher.
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
When true , generates a client secret for the app client.
virtual object GenerateSecret { get; }Property Value
System.
Remarks
Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types .
IdTokenValidity
The ID token time limit.
virtual Nullable<double> IdTokenValidity { get; }Property Value
System.
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. 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
A list of allowed logout URLs for managed login authentication.
virtual string[] LogoutUrLs { get; }Property Value
System.
Remarks
When you pass logout_uri and client_id parameters to /logout , Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of logout_uri . A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint .
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.
virtual string PreventUserExistenceErrors { get; }Property Value
System.
Remarks
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:
Defaults to LEGACY when you don't provide a value.
ReadAttributes
The list of user attributes that you want your app client to have read access to.
virtual string[] ReadAttributes { get; }Property Value
System.
Remarks
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.
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
The refresh token time limit.
virtual Nullable<double> RefreshTokenValidity { get; }Property Value
System.
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. 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
A list of provider names for the identity providers (IdPs) that are supported on this client.
virtual string[] SupportedIdentityProviders { get; }Property Value
System.
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 .
This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of COGNITO from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a AWS WAF rule .
TokenValidityUnits
The units that validity times are represented in.
virtual object TokenValidityUnits { get; }Property Value
System.
Remarks
The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
UserPoolId
The ID of the user pool where you want to create an app client.
string UserPoolId { get; }Property Value
System.
Remarks
WriteAttributes
The list of user attributes that you want your app client to have write access to.
virtual string[] WriteAttributes { get; }Property Value
System.
Remarks
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.
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 .