Amazon Cognito · Example Payload

User Pools User Pool Type Example

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Top-level fields

IdNamePoliciesDeletionProtectionLambdaConfigStatusLastModifiedDateCreationDateSchemaAttributesAutoVerifiedAttributesAliasAttributesUsernameAttributesSmsVerificationMessageEmailVerificationMessageEmailVerificationSubjectVerificationMessageTemplateSmsAuthenticationMessageUserAttributeUpdateSettingsMfaConfigurationDeviceConfigurationEstimatedNumberOfUsersEmailConfigurationSmsConfigurationUserPoolTagsSmsConfigurationFailureEmailConfigurationFailureDomainCustomDomainAdminCreateUserConfigUserPoolAddOnsUsernameConfigurationArnAccountRecoverySetting

Example Payload

Raw ↑ 
{
  "Id": "example-string",
  "Name": "example-name",
  "Policies": "example-string",
  "DeletionProtection": "example-string",
  "LambdaConfig": "example-string",
  "Status": "ACTIVE",
  "LastModifiedDate": "example-string",
  "CreationDate": "example-string",
  "SchemaAttributes": "example-string",
  "AutoVerifiedAttributes": "example-string",
  "AliasAttributes": "example-string",
  "UsernameAttributes": "jsmith",
  "SmsVerificationMessage": "example-string",
  "EmailVerificationMessage": "user@example.com",
  "EmailVerificationSubject": "user@example.com",
  "VerificationMessageTemplate": "example-string",
  "SmsAuthenticationMessage": "example-string",
  "UserAttributeUpdateSettings": "example-string",
  "MfaConfiguration": "example-string",
  "DeviceConfiguration": "example-string",
  "EstimatedNumberOfUsers": "example-string",
  "EmailConfiguration": "user@example.com",
  "SmsConfiguration": "example-string",
  "UserPoolTags": "example-string",
  "SmsConfigurationFailure": "example-string",
  "EmailConfigurationFailure": "user@example.com",
  "Domain": "example-string",
  "CustomDomain": "example-string",
  "AdminCreateUserConfig": "example-string",
  "UserPoolAddOns": "example-string",
  "UsernameConfiguration": "jsmith",
  "Arn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_example",
  "AccountRecoverySetting": "example-string"
}