UserPoolClientState class
Input properties used for looking up and filtering UserPoolClient resources.
Constructors
-
UserPoolClientState({Input<
int?> ? accessTokenValidity, Input<List< ? allowedOauthFlows, Input<String> ?>bool?> ? allowedOauthFlowsUserPoolClient, Input<List< ? allowedOauthScopes, Input<String> ?>UserPoolClientAnalyticsConfiguration?> ? analyticsConfiguration, Input<int?> ? authSessionValidity, Input<List< ? callbackUrls, Input<String> ?>String?> ? clientSecret, Input<String?> ? defaultRedirectUri, Input<bool?> ? enablePropagateAdditionalUserContextData, Input<bool?> ? enableTokenRevocation, Input<List< ? explicitAuthFlows, Input<String> ?>bool?> ? generateSecret, Input<int?> ? idTokenValidity, Input<List< ? logoutUrls, Input<String> ?>String?> ? name, Input<String?> ? preventUserExistenceErrors, Input<List< ? readAttributes, Input<String> ?>UserPoolClientRefreshTokenRotation?> ? refreshTokenRotation, Input<int?> ? refreshTokenValidity, Input<String?> ? region, Input<List< ? supportedIdentityProviders, Input<String> ?>UserPoolClientTokenValidityUnits?> ? tokenValidityUnits, Input<String?> ? userPoolId, Input<List< ? writeAttributes})String> ?> -
Creates a new UserPoolClientState.
accessTokenValidityTime limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value intoken_validity_units.access_token.allowedOauthFlowsList of allowed OAuth flows, includingcode,implicit, andclientCredentials.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.allowedOauthFlowsUserPoolClientWhether the client is allowed to use OAuth 2.0 features.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure the following arguments:callbackUrls,logoutUrls,allowedOauthScopesandallowedOauthFlows.allowedOauthScopesList of allowed OAuth scopes, includingphone,email,openid,profile, andaws.cognito.signin.user.admin.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.analyticsConfigurationConfiguration block for AWS End User Messaging analytics that collects metrics for this user pool. See details below.authSessionValidityDuration, in minutes, of the session token created by Amazon Cognito for each API request in an authentication flow. The session token must be responded to by the native user of the user pool before it expires. Valid values forauthSessionValidityare between3and15, with a default value of3.callbackUrlsList of allowed callback URLs for the identity providers.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.clientSecretClient secret of the user pool client.defaultRedirectUriDefault redirect URI and must be included in the list of callback URLs.enablePropagateAdditionalUserContextDataEnables the propagation of additional user context data.enableTokenRevocationEnables or disables token revocation.explicitAuthFlowsList of authentication flows. The available options includeADMIN_NO_SRP_AUTH,CUSTOM_AUTH_FLOW_ONLY,USER_PASSWORD_AUTH,ALLOW_ADMIN_USER_PASSWORD_AUTH,ALLOW_CUSTOM_AUTH,ALLOW_USER_PASSWORD_AUTH,ALLOW_USER_SRP_AUTH,ALLOW_REFRESH_TOKEN_AUTH, andALLOW_USER_AUTH.generateSecretBoolean flag indicating whether an application secret should be generated.idTokenValidityTime limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value intoken_validity_units.id_token.logoutUrlsList of allowed logout URLs for the identity providers.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.nameName of the application client.preventUserExistenceErrorsSetting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery.readAttributesList of user pool attributes that the application client can read from.refreshTokenRotationA block that specifies the configuration of refresh token rotation. Detailed below.refreshTokenValidityTime limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value intoken_validity_units.refresh_token.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.supportedIdentityProvidersList of provider names for the identity providers that are supported on this client. It uses theproviderNameattribute of theaws.cognito.IdentityProviderresource(s), or the equivalent string(s).tokenValidityUnitsConfiguration block for representing the validity times in units. See details below. Detailed below.userPoolIdUser pool the client belongs to.writeAttributesList of user pool attributes that the application client can write to.const -
UserPoolClientState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accessTokenValidity
→ Input<
int?> ? -
Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in
token_validity_units.access_token.final -
allowedOauthFlows
→ Input<
List< ?String> ?> -
List of allowed OAuth flows, including
code,implicit, andclientCredentials.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.final -
allowedOauthFlowsUserPoolClient
→ Input<
bool?> ? -
Whether the client is allowed to use OAuth 2.0 features.
allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure the following arguments:callbackUrls,logoutUrls,allowedOauthScopesandallowedOauthFlows.final -
allowedOauthScopes
→ Input<
List< ?String> ?> -
List of allowed OAuth scopes, including
phone,email,openid,profile, andaws.cognito.signin.user.admin.allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.final -
analyticsConfiguration
→ Input<
UserPoolClientAnalyticsConfiguration?> ? -
Configuration block for AWS End User Messaging analytics that collects metrics for this user pool. See details below.
final
-
authSessionValidity
→ Input<
int?> ? -
Duration, in minutes, of the session token created by Amazon Cognito for each API request in an authentication flow. The session token must be responded to by the native user of the user pool before it expires. Valid values for
authSessionValidityare between3and15, with a default value of3.final -
callbackUrls
→ Input<
List< ?String> ?> -
List of allowed callback URLs for the identity providers.
allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.final -
clientSecret
→ Input<
String?> ? -
Client secret of the user pool client.
final
-
defaultRedirectUri
→ Input<
String?> ? -
Default redirect URI and must be included in the list of callback URLs.
final
-
enablePropagateAdditionalUserContextData
→ Input<
bool?> ? -
Enables the propagation of additional user context data.
final
-
enableTokenRevocation
→ Input<
bool?> ? -
Enables or disables token revocation.
final
-
explicitAuthFlows
→ Input<
List< ?String> ?> -
List of authentication flows. The available options include
ADMIN_NO_SRP_AUTH,CUSTOM_AUTH_FLOW_ONLY,USER_PASSWORD_AUTH,ALLOW_ADMIN_USER_PASSWORD_AUTH,ALLOW_CUSTOM_AUTH,ALLOW_USER_PASSWORD_AUTH,ALLOW_USER_SRP_AUTH,ALLOW_REFRESH_TOKEN_AUTH, andALLOW_USER_AUTH.final -
generateSecret
→ Input<
bool?> ? -
Boolean flag indicating whether an application secret should be generated.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
idTokenValidity
→ Input<
int?> ? -
Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in
token_validity_units.id_token.final -
logoutUrls
→ Input<
List< ?String> ?> -
List of allowed logout URLs for the identity providers.
allowedOauthFlowsUserPoolClientmust be set totruebefore you can configure this option.final -
name
→ Input<
String?> ? -
Name of the application client.
final
-
preventUserExistenceErrors
→ Input<
String?> ? -
Setting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery.
final
-
readAttributes
→ Input<
List< ?String> ?> -
List of user pool attributes that the application client can read from.
final
-
refreshTokenRotation
→ Input<
UserPoolClientRefreshTokenRotation?> ? -
A block that specifies the configuration of refresh token rotation. Detailed below.
final
-
refreshTokenValidity
→ Input<
int?> ? -
Time limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value in
token_validity_units.refresh_token.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedIdentityProviders
→ Input<
List< ?String> ?> -
List of provider names for the identity providers that are supported on this client. It uses the
providerNameattribute of theaws.cognito.IdentityProviderresource(s), or the equivalent string(s).final -
tokenValidityUnits
→ Input<
UserPoolClientTokenValidityUnits?> ? -
Configuration block for representing the validity times in units. See details below. Detailed below.
final
-
userPoolId
→ Input<
String?> ? -
User pool the client belongs to.
final
-
writeAttributes
→ Input<
List< ?String> ?> -
List of user pool attributes that the application client can write to.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited