Amazon Cognito · JSON Structure

Cognito Idp 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
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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 ↑
{
  "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."
        }
      ]
    },
    "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."
        }
      ]
    },
    "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."
        }
      ]
    }
  },
  "description": "The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-token-validity-units-type-structure.json",
  "name": "TokenValidityUnitsType"
}