Interface ICfnUserPoolClientProps
Properties for defining a CfnUserPoolClient
.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnUserPoolClientProps
Syntax (vb)
Public Interface ICfnUserPoolClientProps
Remarks
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
AccessTokenValidity | The access token time limit. |
AllowedOAuthFlows | The OAuth grant types that you want your app client to generate. |
AllowedOAuthFlowsUserPoolClient | Set to |
AllowedOAuthScopes | The allowed OAuth scopes. |
AnalyticsConfiguration | The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. |
AuthSessionValidity | Amazon Cognito creates a session token for each API request in an authentication flow. |
CallbackUrLs | A list of allowed redirect (callback) URLs for the IdPs. |
ClientName | The client name for the user pool client you would like to create. |
DefaultRedirectUri | The default redirect URI. Must be in the |
EnablePropagateAdditionalUserContextData | Activates the propagation of additional user context data. |
EnableTokenRevocation | Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken . |
ExplicitAuthFlows | The authentication flows that you want your user pool client to support. |
GenerateSecret | Boolean to specify whether you want to generate a secret for the user pool client being created. |
IdTokenValidity | The ID token time limit. |
LogoutUrLs | A list of allowed logout URLs for the IdPs. |
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. |
ReadAttributes | The list of user attributes that you want your app client to have read-only access to. |
RefreshTokenValidity | The refresh token time limit. |
SupportedIdentityProviders | A list of provider names for the identity providers (IdPs) that are supported on this client. |
TokenValidityUnits | The units in which the validity times are represented. |
UserPoolId | The user pool ID for the user pool where you want to create a user pool client. |
WriteAttributes | 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.Nullable<System.Double>
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 OAuth grant types that you want your app client to generate.
virtual string[] AllowedOAuthFlows { get; }
Property Value
System.String[]
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 features in your user pool app client.
virtual object AllowedOAuthFlowsUserPoolClient { get; }
Property Value
System.Object
Remarks
AllowedOAuthFlowsUserPoolClient
must be true
before you can configure the following features in your app client.
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
The allowed OAuth scopes.
virtual string[] AllowedOAuthScopes { get; }
Property Value
System.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.
virtual object AnalyticsConfiguration { get; }
Property Value
System.Object
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.
virtual Nullable<double> AuthSessionValidity { get; }
Property Value
System.Nullable<System.Double>
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.
virtual string[] CallbackUrLs { get; }
Property Value
System.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.
virtual string ClientName { get; }
Property Value
System.String
Remarks
DefaultRedirectUri
The default redirect URI. Must be in the CallbackURLs
list.
virtual string DefaultRedirectUri { get; }
Property Value
System.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.
EnablePropagateAdditionalUserContextData
Activates the propagation of additional user context data.
virtual object EnablePropagateAdditionalUserContextData { get; }
Property Value
System.Object
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 .
virtual object EnableTokenRevocation { get; }
Property Value
System.Object
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.
virtual string[] ExplicitAuthFlows { get; }
Property Value
System.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 ExplicitAuthFlows
, your user client supports ALLOW_REFRESH_TOKEN_AUTH
, ALLOW_USER_SRP_AUTH
, and ALLOW_CUSTOM_AUTH
.
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.
virtual object GenerateSecret { get; }
Property Value
System.Object
Remarks
IdTokenValidity
The ID token time limit.
virtual Nullable<double> IdTokenValidity { get; }
Property Value
System.Nullable<System.Double>
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.
virtual string[] LogoutUrLs { get; }
Property Value
System.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.
virtual string PreventUserExistenceErrors { get; }
Property Value
System.String
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 list of user attributes that you want your app client to have read-only access to.
virtual string[] ReadAttributes { get; }
Property Value
System.String[]
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. 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 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.Nullable<System.Double>
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.
virtual string[] SupportedIdentityProviders { get; }
Property Value
System.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.
virtual object TokenValidityUnits { get; }
Property Value
System.Object
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.
string UserPoolId { get; }
Property Value
System.String
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.String[]
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. 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 .