Amazon Cognito · Example Payload

User Pools User Pool Client Type Example

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Top-level fields

UserPoolIdClientNameClientIdClientSecretLastModifiedDateCreationDateRefreshTokenValidityAccessTokenValidityIdTokenValidityTokenValidityUnitsReadAttributesWriteAttributesExplicitAuthFlowsSupportedIdentityProvidersCallbackURLsLogoutURLsDefaultRedirectURIAllowedOAuthFlowsAllowedOAuthScopesAllowedOAuthFlowsUserPoolClientAnalyticsConfigurationPreventUserExistenceErrorsEnableTokenRevocationEnablePropagateAdditionalUserContextDataAuthSessionValidity

Example Payload

Raw ↑ 
{
  "UserPoolId": "us-east-1_example",
  "ClientName": "example-name",
  "ClientId": "example-string",
  "ClientSecret": "example-string",
  "LastModifiedDate": "example-string",
  "CreationDate": "example-string",
  "RefreshTokenValidity": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
  "AccessTokenValidity": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
  "IdTokenValidity": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
  "TokenValidityUnits": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
  "ReadAttributes": "example-string",
  "WriteAttributes": "example-string",
  "ExplicitAuthFlows": "example-string",
  "SupportedIdentityProviders": "example-string",
  "CallbackURLs": "example-string",
  "LogoutURLs": "example-string",
  "DefaultRedirectURI": "example-string",
  "AllowedOAuthFlows": "example-string",
  "AllowedOAuthScopes": "example-string",
  "AllowedOAuthFlowsUserPoolClient": "example-string",
  "AnalyticsConfiguration": "example-string",
  "PreventUserExistenceErrors": "example-string",
  "EnableTokenRevocation": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
  "EnablePropagateAdditionalUserContextData": "example-string",
  "AuthSessionValidity": "example-string"
}