Amazon Cognito · Example Payload

User Pools Create User Pool Client Request Example

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Top-level fields

UserPoolIdClientNameGenerateSecretRefreshTokenValidityAccessTokenValidityIdTokenValidityTokenValidityUnitsReadAttributesWriteAttributesExplicitAuthFlowsSupportedIdentityProvidersCallbackURLsLogoutURLsDefaultRedirectURIAllowedOAuthFlowsAllowedOAuthScopesAllowedOAuthFlowsUserPoolClientAnalyticsConfigurationPreventUserExistenceErrorsEnableTokenRevocationEnablePropagateAdditionalUserContextDataAuthSessionValidity

Example Payload

Raw ↑ 
{
  "UserPoolId": "us-east-1_example",
  "ClientName": "example-name",
  "GenerateSecret": "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"
}