GetUserPoolClientResult class
Result data returned by getUserPoolClient.
Constructors
-
GetUserPoolClientResult({int? accessTokenValidity, List<
String> ? allowedOauthFlows, bool? allowedOauthFlowsUserPoolClient, List<String> ? allowedOauthScopes, List<GetUserPoolClientAnalyticsConfiguration> ? analyticsConfigurations, List<String> ? callbackUrls, String? clientId, String? clientSecret, String? defaultRedirectUri, bool? enablePropagateAdditionalUserContextData, bool? enableTokenRevocation, List<String> ? explicitAuthFlows, bool? generateSecret, String? id, int? idTokenValidity, List<String> ? logoutUrls, String? name, String? preventUserExistenceErrors, List<String> ? readAttributes, List<GetUserPoolClientRefreshTokenRotation> ? refreshTokenRotations, int? refreshTokenValidity, String? region, List<String> ? supportedIdentityProviders, List<GetUserPoolClientTokenValidityUnit> ? tokenValidityUnits, String? userPoolId, List<String> ? writeAttributes}) -
Creates a new GetUserPoolClientResult.
accessTokenValidity(Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value intokenValidityUnits.allowedOauthFlows(Optional) List of allowed OAuth flows (code, implicit, client_credentials).allowedOauthFlowsUserPoolClient(Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.allowedOauthScopes(Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).analyticsConfigurations(Optional) Configuration block for AWS End User Messaging analytics for collecting metrics for this user pool. Detailed below.callbackUrls(Optional) List of allowed callback URLs for the identity providers.clientIdOptional.clientSecretClient secret of the user pool client.defaultRedirectUri(Optional) Default redirect URI. Must be in the list of callback URLs.enablePropagateAdditionalUserContextDataOptional.enableTokenRevocation(Optional) Enables or disables token revocation.explicitAuthFlows(Optional) List of authentication flows (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).generateSecret(Optional) Should an application secret be generated.idThe provider-assigned unique ID for this managed resource.idTokenValidity(Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value intokenValidityUnits.logoutUrls(Optional) List of allowed logout URLs for the identity providers.nameOptional.preventUserExistenceErrors(Optional) 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. When set toENABLEDand 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 toLEGACY, those APIs will return aUserNotFoundExceptionexception if the user does not exist in the user pool.readAttributes(Optional) List of user pool attributes the application client can read from.refreshTokenRotations(Optional) A block that specifies the configuration of refresh token rotation. Detailed below.refreshTokenValidity(Optional) Time limit in days refresh tokens are valid for.regionOptional.supportedIdentityProviders(Optional) List of provider names for the identity providers that are supported on this client. Uses theproviderNameattribute ofaws.cognito.IdentityProviderresource(s), or the equivalent string(s).tokenValidityUnits(Optional) Configuration block for units in which the validity times are represented in. Detailed below.userPoolIdOptional.writeAttributes(Optional) List of user pool attributes the application client can write to.const -
GetUserPoolClientResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- accessTokenValidity → int?
-
(Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
tokenValidityUnits.final -
allowedOauthFlows
→ List<
String> ? -
(Optional) List of allowed OAuth flows (code, implicit, client_credentials).
final
- allowedOauthFlowsUserPoolClient → bool?
-
(Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
final
-
allowedOauthScopes
→ List<
String> ? -
(Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
final
-
analyticsConfigurations
→ List<
GetUserPoolClientAnalyticsConfiguration> ? -
(Optional) Configuration block for AWS End User Messaging analytics for collecting metrics for this user pool. Detailed below.
final
-
callbackUrls
→ List<
String> ? -
(Optional) List of allowed callback URLs for the identity providers.
final
- clientId → String?
-
final
- clientSecret → String?
-
Client secret of the user pool client.
final
- defaultRedirectUri → String?
-
(Optional) Default redirect URI. Must be in the list of callback URLs.
final
- enablePropagateAdditionalUserContextData → bool?
-
final
- enableTokenRevocation → bool?
-
(Optional) Enables or disables token revocation.
final
-
explicitAuthFlows
→ List<
String> ? -
(Optional) List of authentication flows (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).
final
- generateSecret → bool?
-
(Optional) Should an application secret be generated.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
The provider-assigned unique ID for this managed resource.
final
- idTokenValidity → int?
-
(Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
tokenValidityUnits.final -
logoutUrls
→ List<
String> ? -
(Optional) List of allowed logout URLs for the identity providers.
final
- name → String?
-
final
- preventUserExistenceErrors → String?
-
(Optional) 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. When set to
ENABLEDand 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 toLEGACY, those APIs will return aUserNotFoundExceptionexception if the user does not exist in the user pool.final -
readAttributes
→ List<
String> ? -
(Optional) List of user pool attributes the application client can read from.
final
-
refreshTokenRotations
→ List<
GetUserPoolClientRefreshTokenRotation> ? -
(Optional) A block that specifies the configuration of refresh token rotation. Detailed below.
final
- refreshTokenValidity → int?
-
(Optional) Time limit in days refresh tokens are valid for.
final
- region → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedIdentityProviders
→ List<
String> ? -
(Optional) List of provider names for the identity providers that are supported on this client. Uses the
providerNameattribute ofaws.cognito.IdentityProviderresource(s), or the equivalent string(s).final -
tokenValidityUnits
→ List<
GetUserPoolClientTokenValidityUnit> ? -
(Optional) Configuration block for units in which the validity times are represented in. Detailed below.
final
- userPoolId → String?
-
final
-
writeAttributes
→ List<
String> ? -
(Optional) List of user pool attributes 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