Amazon Cognito · Example Payload

Cognito Idp Create User Pool Request Example

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Cognito Idp Create User Pool Request Example is an example object payload from Amazon Cognito, with 23 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

PoolNamePoliciesDeletionProtectionLambdaConfigAutoVerifiedAttributesAliasAttributesUsernameAttributesSmsVerificationMessageEmailVerificationMessageEmailVerificationSubjectVerificationMessageTemplateSmsAuthenticationMessageMfaConfigurationUserAttributeUpdateSettingsDeviceConfigurationEmailConfigurationSmsConfigurationUserPoolTagsAdminCreateUserConfigSchemaUserPoolAddOnsUsernameConfigurationAccountRecoverySetting

Example Payload

Raw ↑ 
{
  "PoolName": "my-user-pool-01",
  "Policies": "example-value",
  "DeletionProtection": "example-value",
  "LambdaConfig": "example-value",
  "AutoVerifiedAttributes": "example-value",
  "AliasAttributes": "example-value",
  "UsernameAttributes": "my-user-pool-01",
  "SmsVerificationMessage": "example-value",
  "EmailVerificationMessage": "user@example.com",
  "EmailVerificationSubject": "user@example.com",
  "VerificationMessageTemplate": "example-value",
  "SmsAuthenticationMessage": "example-value",
  "MfaConfiguration": "example-value",
  "UserAttributeUpdateSettings": "example-value",
  "DeviceConfiguration": "example-value",
  "EmailConfiguration": "user@example.com",
  "SmsConfiguration": "example-value",
  "UserPoolTags": "example-value",
  "AdminCreateUserConfig": "example-value",
  "Schema": "example-value",
  "UserPoolAddOns": "example-value",
  "UsernameConfiguration": "my-user-pool-01",
  "AccountRecoverySetting": "example-value"
}