| Package | Description |
|---|---|
| com.amazonaws.services.cognitoidp.model |
| Modifier and Type | Method and Description |
|---|---|
UserPoolClientType |
UserPoolClientType.clone() |
UserPoolClientType |
UpdateUserPoolClientResult.getUserPoolClient()
The user pool client value from the response from the server when you request to update the user pool client.
|
UserPoolClientType |
CreateUserPoolClientResult.getUserPoolClient()
The user pool client that was just created.
|
UserPoolClientType |
DescribeUserPoolClientResult.getUserPoolClient()
The user pool client from a server response to describe the user pool client.
|
UserPoolClientType |
UserPoolClientType.withAccessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
UserPoolClientType |
UserPoolClientType.withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
UserPoolClientType.withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
UserPoolClientType.withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
UserPoolClientType.withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app client. |
UserPoolClientType |
UserPoolClientType.withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The OAuth scopes that your app client supports.
|
UserPoolClientType |
UserPoolClientType.withAllowedOAuthScopes(String... allowedOAuthScopes)
The OAuth scopes that your app client supports.
|
UserPoolClientType |
UserPoolClientType.withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
|
UserPoolClientType |
UserPoolClientType.withAuthSessionValidity(Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an authentication flow.
|
UserPoolClientType |
UserPoolClientType.withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UserPoolClientType |
UserPoolClientType.withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UserPoolClientType |
UserPoolClientType.withClientId(String clientId)
The ID of the client associated with the user pool.
|
UserPoolClientType |
UserPoolClientType.withClientName(String clientName)
The client name from the user pool request of the client type.
|
UserPoolClientType |
UserPoolClientType.withClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
|
UserPoolClientType |
UserPoolClientType.withCreationDate(Date creationDate)
The date and time when the item was created.
|
UserPoolClientType |
UserPoolClientType.withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UserPoolClientType |
UserPoolClientType.withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
When
EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. |
UserPoolClientType |
UserPoolClientType.withEnableTokenRevocation(Boolean enableTokenRevocation)
Indicates whether token revocation is activated for the user pool client.
|
UserPoolClientType |
UserPoolClientType.withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
UserPoolClientType.withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
UserPoolClientType.withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
UserPoolClientType.withIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
UserPoolClientType |
UserPoolClientType.withLastModifiedDate(Date lastModifiedDate)
The date and time when the item was modified.
|
UserPoolClientType |
UserPoolClientType.withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UserPoolClientType |
UserPoolClientType.withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UserPoolClientType |
UserPoolClientType.withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool.
|
UserPoolClientType |
UserPoolClientType.withPreventUserExistenceErrors(String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool.
|
UserPoolClientType |
UserPoolClientType.withReadAttributes(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
UserPoolClientType |
UserPoolClientType.withReadAttributes(String... readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
UserPoolClientType |
UserPoolClientType.withRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
UserPoolClientType |
UserPoolClientType.withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UserPoolClientType |
UserPoolClientType.withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UserPoolClientType |
UserPoolClientType.withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units used to specify the token validity times of each token type: ID, access, and refresh.
|
UserPoolClientType |
UserPoolClientType.withUserPoolId(String userPoolId)
The user pool ID for the user pool client.
|
UserPoolClientType |
UserPoolClientType.withWriteAttributes(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
UserPoolClientType |
UserPoolClientType.withWriteAttributes(String... writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UpdateUserPoolClientResult.setUserPoolClient(UserPoolClientType userPoolClient)
The user pool client value from the response from the server when you request to update the user pool client.
|
void |
CreateUserPoolClientResult.setUserPoolClient(UserPoolClientType userPoolClient)
The user pool client that was just created.
|
void |
DescribeUserPoolClientResult.setUserPoolClient(UserPoolClientType userPoolClient)
The user pool client from a server response to describe the user pool client.
|
UpdateUserPoolClientResult |
UpdateUserPoolClientResult.withUserPoolClient(UserPoolClientType userPoolClient)
The user pool client value from the response from the server when you request to update the user pool client.
|
CreateUserPoolClientResult |
CreateUserPoolClientResult.withUserPoolClient(UserPoolClientType userPoolClient)
The user pool client that was just created.
|
DescribeUserPoolClientResult |
DescribeUserPoolClientResult.withUserPoolClient(UserPoolClientType userPoolClient)
The user pool client from a server response to describe the user pool client.
|
Copyright © 2025. All rights reserved.