UserPoolClientType class

Contains information about a user pool client.

Constructors

UserPoolClientType({int? accessTokenValidity, List<OAuthFlowType>? allowedOAuthFlows, bool? allowedOAuthFlowsUserPoolClient, List<String>? allowedOAuthScopes, AnalyticsConfigurationType? analyticsConfiguration, List<String>? callbackURLs, String? clientId, String? clientName, String? clientSecret, DateTime? creationDate, String? defaultRedirectURI, List<ExplicitAuthFlowsType>? explicitAuthFlows, int? idTokenValidity, DateTime? lastModifiedDate, List<String>? logoutURLs, PreventUserExistenceErrorTypes? preventUserExistenceErrors, List<String>? readAttributes, int? refreshTokenValidity, List<String>? supportedIdentityProviders, TokenValidityUnitsType? tokenValidityUnits, String? userPoolId, List<String>? writeAttributes})

UserPoolClientType.fromJson(Map<String, dynamic> json)

factory

Properties

accessTokenValidity → int?

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

final

allowedOAuthFlows → List<OAuthFlowType>?

The allowed OAuth flows.

final

allowedOAuthFlowsUserPoolClient → bool?

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

final

allowedOAuthScopes → List<String>?

The allowed OAuth scopes. 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.

final

analyticsConfiguration → AnalyticsConfigurationType?

The Amazon Pinpoint analytics configuration for the user pool client.

final

callbackURLs → List<String>?

A list of allowed redirect (callback) URLs for the identity providers.

final

clientId → String?

The ID of the client associated with the user pool.

final

clientName → String?

The client name from the user pool request of the client type.

final

clientSecret → String?

The client secret from the user pool request of the client type.

final

creationDate → DateTime?

The date the user pool client was created.

final

defaultRedirectURI → String?

The default redirect URI. Must be in the CallbackURLs list.

final

explicitAuthFlows → List<ExplicitAuthFlowsType>?

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

final

hashCode → int

The hash code for this object.

no setter, inherited

idTokenValidity → int?

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

final

lastModifiedDate → DateTime?

The date the user pool client was last modified.

final

logoutURLs → List<String>?

A list of allowed logout URLs for the identity providers.

final

preventUserExistenceErrors → PreventUserExistenceErrorTypes?

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. 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.

final

readAttributes → List<String>?

The Read-only attributes.

final

refreshTokenValidity → int?

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

supportedIdentityProviders → List<String>?

A list of provider names for the identity providers that are supported on this client.

final

tokenValidityUnits → TokenValidityUnitsType?

The time units used to specify the token validity times of their respective token.

final

userPoolId → String?

The user pool ID for the user pool client.

final

writeAttributes → List<String>?

The writeable attributes.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited