Class CfnUserPoolClientProps.Jsii$Proxy
- All Implemented Interfaces:
CfnUserPoolClientProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnUserPoolClientProps
CfnUserPoolClientProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolClientProps
CfnUserPoolClientProps.Builder, CfnUserPoolClientProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnUserPoolClientProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnUserPoolClientProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal NumberThe access token time limit.The OAuth grant types that you want your app client to generate for clients in managed login authentication.final ObjectSet totrueto use OAuth 2.0 authorization server features in your app client.The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.final ObjectThe user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.final NumberAmazon Cognito creates a session token for each API request in an authentication flow.A list of allowed redirect, or callback, URLs for managed login authentication.final StringA friendly name for the app client that you want to create.final StringThe default redirect URI.final ObjectWhentrue, your application can include additionalUserContextDatain authentication requests.final ObjectActivates or deactivates token revocation.The authentication flows that you want your user pool client to support.final ObjectWhentrue, generates a client secret for the app client.final NumberThe ID token time limit.A list of allowed logout URLs for managed login authentication.final StringErrors 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.The list of user attributes that you want your app client to have read access to.final ObjectThe configuration of your app client for refresh token rotation.final NumberThe refresh token time limit.A list of provider names for the identity providers (IdPs) that are supported on this client.final ObjectThe units that validity times are represented in.final ObjectThe ID of the user pool where you want to create an app client.The list of user attributes that you want your app client to have write access to.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnUserPoolClientProps.Builder.
-
-
Method Details
-
getUserPoolId
Description copied from interface:CfnUserPoolClientPropsThe ID of the user pool where you want to create an app client.Returns union: either
StringorIUserPoolRef- Specified by:
getUserPoolIdin interfaceCfnUserPoolClientProps- See Also:
-
getAccessTokenValidity
Description copied from interface:CfnUserPoolClientPropsThe access token time limit.After this limit expires, your user can't use their access token. To specify the time unit for
AccessTokenValidityasseconds,minutes,hours, ordays, set aTokenValidityUnitsvalue in your API request.For example, when you set
AccessTokenValidityto10andTokenValidityUnitstohours, your user can authorize access with their access token for 10 hours.The default time unit for
AccessTokenValidityin an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
- Specified by:
getAccessTokenValidityin interfaceCfnUserPoolClientProps- See Also:
-
getAllowedOAuthFlows
Description copied from interface:CfnUserPoolClientPropsThe OAuth grant types that you want your app client to generate for clients in managed login authentication.To create an app client that generates client credentials grants, you must add
client_credentialsas the only allowed OAuth flow.- code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/tokenendpoint. - implicit - Issue the access token, and the ID token when scopes like
openidandprofileare requested, directly to your user. - client_credentials - Issue the access token from the
/oauth2/tokenendpoint directly to a non-person user, authorized by a combination of the client ID and client secret.
- Specified by:
getAllowedOAuthFlowsin interfaceCfnUserPoolClientProps- See Also:
- code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
-
getAllowedOAuthFlowsUserPoolClient
Description copied from interface:CfnUserPoolClientPropsSet totrueto use OAuth 2.0 authorization server features in your app client.This parameter must have a value of
truebefore you can configure the following features in your app client.CallBackURLs: Callback URLs.LogoutURLs: Sign-out redirect URLs.AllowedOAuthScopes: OAuth 2.0 scopes.AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClienttotruein aCreateUserPoolClientorUpdateUserPoolClientAPI request. If you don't set a value forAllowedOAuthFlowsUserPoolClientin a request with the AWS CLI or SDKs, it defaults tofalse. Whenfalse, only SDK-based API sign-in is permitted.Returns union: either
BooleanorIResolvable- Specified by:
getAllowedOAuthFlowsUserPoolClientin interfaceCfnUserPoolClientProps- See Also:
-
getAllowedOAuthScopes
Description copied from interface:CfnUserPoolClientPropsThe OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.Scopes govern access control to user pool self-service API operations, user data from the
userInfoendpoint, and third-party APIs. Scope values includephone,email,openid, andprofile. Theaws.cognito.signin.user.adminscope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.- Specified by:
getAllowedOAuthScopesin interfaceCfnUserPoolClientProps- See Also:
-
getAnalyticsConfiguration
Description copied from interface:CfnUserPoolClientPropsThe user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics .
Returns union: either
IResolvableorCfnUserPoolClient.AnalyticsConfigurationProperty- Specified by:
getAnalyticsConfigurationin interfaceCfnUserPoolClientProps- See Also:
-
getAuthSessionValidity
Description copied from interface:CfnUserPoolClientPropsAmazon Cognito creates a session token for each API request in an authentication flow.AuthSessionValidityis the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.- Specified by:
getAuthSessionValidityin interfaceCfnUserPoolClientProps- See Also:
-
getCallbackUrLs
Description copied from interface:CfnUserPoolClientPropsA list of allowed redirect, or callback, URLs for managed login authentication.These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.
A redirect URI must meet the following requirements:
- Be an absolute URI.
- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with
redirect_urivalues that aren't in the list ofCallbackURLsthat you provide in this parameter. - Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for callback URLs to
http://localhost,http://127.0.0.1andhttp://[::1]. These callback URLs are for testing purposes only. You can specify custom TCP ports for your callback URLs.App callback URLs such as
myapp://exampleare also supported.- Specified by:
getCallbackUrLsin interfaceCfnUserPoolClientProps- See Also:
-
getClientName
Description copied from interface:CfnUserPoolClientPropsA friendly name for the app client that you want to create.- Specified by:
getClientNamein interfaceCfnUserPoolClientProps- See Also:
-
getDefaultRedirectUri
Description copied from interface:CfnUserPoolClientPropsThe default redirect URI.In app clients with one assigned IdP, replaces
redirect_uriin authentication requests. Must be in theCallbackURLslist.- Specified by:
getDefaultRedirectUriin interfaceCfnUserPoolClientProps- See Also:
-
getEnablePropagateAdditionalUserContextData
Description copied from interface:CfnUserPoolClientPropsWhentrue, your application can include additionalUserContextDatain authentication requests.This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate
EnablePropagateAdditionalUserContextDatain an app client that has a client secret.Returns union: either
BooleanorIResolvable- Specified by:
getEnablePropagateAdditionalUserContextDatain interfaceCfnUserPoolClientProps- See Also:
-
getEnableTokenRevocation
Description copied from interface:CfnUserPoolClientPropsActivates or deactivates token revocation.If you don't include this parameter, token revocation is automatically activated for the new user pool client.
Returns union: either
BooleanorIResolvable- Specified by:
getEnableTokenRevocationin interfaceCfnUserPoolClientProps- See Also:
-
getExplicitAuthFlows
Description copied from interface:CfnUserPoolClientPropsThe authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.If you don't specify a value for
ExplicitAuthFlows, your app client supportsALLOW_REFRESH_TOKEN_AUTH,ALLOW_USER_SRP_AUTH, andALLOW_CUSTOM_AUTH.The values for authentication flow options include the following.
ALLOW_USER_AUTH: Enable selection-based sign-in withUSER_AUTH. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without otherExplicitAuthFlowspermitting them. For example users can complete an SRP challenge throughUSER_AUTHwithout the flowUSER_SRP_AUTHbeing active for the app client. This flow doesn't includeCUSTOM_AUTH.
To activate this setting, your user pool must be in the Essentials tier or higher.
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH. This setting replaces theADMIN_NO_SRP_AUTHsetting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,CUSTOM_AUTH_FLOW_ONLY, orUSER_PASSWORD_AUTH. You can't assign these legacyExplicitAuthFlowsvalues to user pool clients at the same time as values that begin withALLOW_, likeALLOW_USER_SRP_AUTH.- Specified by:
getExplicitAuthFlowsin interfaceCfnUserPoolClientProps- See Also:
-
getGenerateSecret
Description copied from interface:CfnUserPoolClientPropsWhentrue, generates a client secret for the app client.Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types .
Returns union: either
BooleanorIResolvable- Specified by:
getGenerateSecretin interfaceCfnUserPoolClientProps- See Also:
-
getIdTokenValidity
Description copied from interface:CfnUserPoolClientPropsThe ID token time limit.After this limit expires, your user can't use their ID token. To specify the time unit for
IdTokenValidityasseconds,minutes,hours, ordays, set aTokenValidityUnitsvalue in your API request.For example, when you set
IdTokenValidityas10andTokenValidityUnitsashours, your user can authenticate their session with their ID token for 10 hours.The default time unit for
IdTokenValidityin an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
- Specified by:
getIdTokenValidityin interfaceCfnUserPoolClientProps- See Also:
-
getLogoutUrLs
Description copied from interface:CfnUserPoolClientPropsA list of allowed logout URLs for managed login authentication.When you pass
logout_uriandclient_idparameters to/logout, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets oflogout_uri. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint .- Specified by:
getLogoutUrLsin interfaceCfnUserPoolClientProps- See Also:
-
getPreventUserExistenceErrors
Description copied from interface:CfnUserPoolClientPropsErrors 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.When set to
ENABLEDand the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY, those APIs return aUserNotFoundExceptionexception if the user doesn't exist in the user pool.Valid values include:
ENABLED- This prevents user existence-related errors.LEGACY- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
Defaults to
LEGACYwhen you don't provide a value.- Specified by:
getPreventUserExistenceErrorsin interfaceCfnUserPoolClientProps- See Also:
-
getReadAttributes
Description copied from interface:CfnUserPoolClientPropsThe list of user attributes that you want your app client to have read access to.After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information.
When you don't specify the
ReadAttributesfor your app client, your app can read the values ofemail_verified,phone_number_verified, and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes,ReadAttributesdoesn't return any information. Amazon Cognito only populatesReadAttributesin the API response if you have specified your own custom set of read attributes.- Specified by:
getReadAttributesin interfaceCfnUserPoolClientProps- See Also:
-
getRefreshTokenRotation
Description copied from interface:CfnUserPoolClientPropsThe configuration of your app client for refresh token rotation.When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.
Returns union: either
IResolvableorCfnUserPoolClient.RefreshTokenRotationProperty- Specified by:
getRefreshTokenRotationin interfaceCfnUserPoolClientProps- See Also:
-
getRefreshTokenValidity
Description copied from interface:CfnUserPoolClientPropsThe refresh token time limit.After this limit expires, your user can't use their refresh token. To specify the time unit for
RefreshTokenValidityasseconds,minutes,hours, ordays, set aTokenValidityUnitsvalue in your API request.For example, when you set
RefreshTokenValidityas10andTokenValidityUnitsasdays, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for
RefreshTokenValidityin an API request is days. You can't setRefreshTokenValidityto 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
- Specified by:
getRefreshTokenValidityin interfaceCfnUserPoolClientProps- See Also:
-
getSupportedIdentityProviders
Description copied from interface:CfnUserPoolClientPropsA list of provider names for the identity providers (IdPs) that are supported on this client.The following are supported:
COGNITO,Facebook,Google,SignInWithApple, andLoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdPorMyOIDCIdP.This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of
COGNITOfrom this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a AWS WAF rule .- Specified by:
getSupportedIdentityProvidersin interfaceCfnUserPoolClientProps- See Also:
-
getTokenValidityUnits
Description copied from interface:CfnUserPoolClientPropsThe units that validity times are represented in.The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
Returns union: either
IResolvableorCfnUserPoolClient.TokenValidityUnitsProperty- Specified by:
getTokenValidityUnitsin interfaceCfnUserPoolClientProps- See Also:
-
getWriteAttributes
Description copied from interface:CfnUserPoolClientPropsThe list of user attributes that you want your app client to have write access to.After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.
When you don't specify the
WriteAttributesfor your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes,WriteAttributesdoesn't return any information. Amazon Cognito only populatesWriteAttributesin the API response if you have specified your own custom set of write attributes.If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
- Specified by:
getWriteAttributesin interfaceCfnUserPoolClientProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-