UserPoolClientState constructor
- Input<
int?> ? accessTokenValidity, - Input<
List< ? allowedOauthFlows,String> ?> - Input<
bool?> ? allowedOauthFlowsUserPoolClient, - Input<
List< ? allowedOauthScopes,String> ?> - Input<
UserPoolClientAnalyticsConfiguration?> ? analyticsConfiguration, - Input<
int?> ? authSessionValidity, - Input<
List< ? callbackUrls,String> ?> - Input<
String?> ? clientSecret, - Input<
String?> ? defaultRedirectUri, - Input<
bool?> ? enablePropagateAdditionalUserContextData, - Input<
bool?> ? enableTokenRevocation, - Input<
List< ? explicitAuthFlows,String> ?> - Input<
bool?> ? generateSecret, - Input<
int?> ? idTokenValidity, - Input<
List< ? logoutUrls,String> ?> - Input<
String?> ? name, - Input<
String?> ? preventUserExistenceErrors, - Input<
List< ? readAttributes,String> ?> - Input<
UserPoolClientRefreshTokenRotation?> ? refreshTokenRotation, - Input<
int?> ? refreshTokenValidity, - Input<
String?> ? region, - Input<
List< ? supportedIdentityProviders,String> ?> - Input<
UserPoolClientTokenValidityUnits?> ? tokenValidityUnits, - Input<
String?> ? userPoolId, - Input<
List< ? writeAttributes,String> ?>
Creates a new UserPoolClientState.
accessTokenValidity 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.
allowedOauthFlows List of allowed OAuth flows, including code, implicit, and clientCredentials. allowedOauthFlowsUserPoolClient must be set to true before you can configure this option.
allowedOauthFlowsUserPoolClient Whether the client is allowed to use OAuth 2.0 features. allowedOauthFlowsUserPoolClient must be set to true before you can configure the following arguments: callbackUrls, logoutUrls, allowedOauthScopes and allowedOauthFlows.
allowedOauthScopes List of allowed OAuth scopes, including phone, email, openid, profile, and aws.cognito.signin.user.admin. allowedOauthFlowsUserPoolClient must be set to true before you can configure this option.
analyticsConfiguration Configuration block for AWS End User Messaging analytics that collects metrics for this user pool. See details below.
authSessionValidity 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 authSessionValidity are between 3 and 15, with a default value of 3.
callbackUrls List of allowed callback URLs for the identity providers. allowedOauthFlowsUserPoolClient must be set to true before you can configure this option.
clientSecret Client secret of the user pool client.
defaultRedirectUri Default redirect URI and must be included in the list of callback URLs.
enablePropagateAdditionalUserContextData Enables the propagation of additional user context data.
enableTokenRevocation Enables or disables token revocation.
explicitAuthFlows 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, and ALLOW_USER_AUTH.
generateSecret Boolean flag indicating whether an application secret should be generated.
idTokenValidity 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.
logoutUrls List of allowed logout URLs for the identity providers. allowedOauthFlowsUserPoolClient must be set to true before you can configure this option.
name Name of the application client.
preventUserExistenceErrors 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.
readAttributes List of user pool attributes that the application client can read from.
refreshTokenRotation A block that specifies the configuration of refresh token rotation. Detailed below.
refreshTokenValidity 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.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
supportedIdentityProviders List of provider names for the identity providers that are supported on this client. It uses the providerName attribute of the aws.cognito.IdentityProvider resource(s), or the equivalent string(s).
tokenValidityUnits Configuration block for representing the validity times in units. See details below. Detailed below.
userPoolId User pool the client belongs to.
writeAttributes List of user pool attributes that the application client can write to.
Implementation
const UserPoolClientState({
this.accessTokenValidity,
this.allowedOauthFlows,
this.allowedOauthFlowsUserPoolClient,
this.allowedOauthScopes,
this.analyticsConfiguration,
this.authSessionValidity,
this.callbackUrls,
this.clientSecret,
this.defaultRedirectUri,
this.enablePropagateAdditionalUserContextData,
this.enableTokenRevocation,
this.explicitAuthFlows,
this.generateSecret,
this.idTokenValidity,
this.logoutUrls,
this.name,
this.preventUserExistenceErrors,
this.readAttributes,
this.refreshTokenRotation,
this.refreshTokenValidity,
this.region,
this.supportedIdentityProviders,
this.tokenValidityUnits,
this.userPoolId,
this.writeAttributes,
});