Amazon Cognito · JSON Structure

User Pools Token Validity Units Type Structure

The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.

Type: object Properties: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

TokenValidityUnitsType is a JSON Structure definition published by Amazon Cognito, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AccessToken IdToken RefreshToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-token-validity-units-type-structure.json",
  "name": "TokenValidityUnitsType",
  "description": "The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeUnitsType"
        },
        {
          "description": " A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code> for the value that you set in the <code>AccessTokenValidity</code> parameter. The default <code>AccessTokenValidity</code> time unit is hours. <code>AccessTokenValidity</code> duration can range from five minutes to one day."
        }
      ]
    },
    "IdToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeUnitsType"
        },
        {
          "description": "A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code> for the value that you set in the <code>IdTokenValidity</code> parameter. The default <code>IdTokenValidity</code> time unit is hours. <code>IdTokenValidity</code> duration can range from five minutes to one day."
        }
      ]
    },
    "RefreshToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeUnitsType"
        },
        {
          "description": "A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code> for the value that you set in the <code>RefreshTokenValidity</code> parameter. The default <code>RefreshTokenValidity</code> time unit is days. <code>RefreshTokenValidity</code> duration can range from 60 minutes to 10 years."
        }
      ]
    }
  }
}