How to modify expiry time of the access and identity tokens for AWS Cognito User Pools

Question

I can't find any documentation which explains if and how to modify the expiry time of access and identity tokens for AWS Cognito User Pools.

The documentation specifies that by default expires 1h after the emission.

Is there a way to modify the expiry time?

Answer 1

As other answers have mentioned, what you probably want here is edit the refresh token duration.

As of June 2024, in AWS Cognito, if you go to your User pools, then click on the user pool, you will land on the pool details with some tabs. Click on App integration, scroll down to App client list and select a client. Once there, you can see your app client details in the top card and you will see what is currently set up for your refresh token and access token: app client card

Click edit and you can then change your refresh token to a different duration here. app client edit view

(Very much the same as Rahul's answer)

Answer 2

As of August 12,2020, AWS has announced that user pools now supports customization of token expiration. Here are the steps to follow:

1. Open your AWS Cognito console.
2. Go to App integration.
3. Scroll down to App clients and click edit.
4. Click on Show Details button to see the customization options like below:
   
   

Access token expiration must be between 5 minutes and 1 day. Cannot be greater than refresh token expiration.

For further detail on AWS cognito you can follow this link.

Answer 3

Updated answer (as of Dec 13, 2022):

1. Open your AWS Cognito Console (don't switch back to old console)
2. Click "User pools"
3. Click the User pool you'd like to configure
4. You should see tabs: "Users, Groups, Sign-in experience, Sign-up experience, Messaging, App integration, User pool properties". Select "App integration".
5. Scroll to the bottom where you see the App client list
6. Select the relevant app client
7. You should see "App client information". Tap edit.

Finally, you should see an input for "Refresh token expiration".

Answer 4

If you are using CloudFormation template, add the following attribute and specify in days (although the official docs say that it defaults to hours) how long the access token should be valid. Here is an example where Access Token is valid for 24 days.

UserPoolClient:
    Type: "AWS::Cognito::UserPoolClient"
    Properties:
        ClientName: myuserpoolclient
        GenerateSecret: true
        UserPoolId: !Ref YourUserPool
        AccessTokenValidity: 24

Documentation: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html#CognitoUserPools-CreateUserPoolClient-request-AccessTokenValidity

Answer 5

This is currently not possible to configure for your user pool. They are set to one hour for everyone.

Edit: see Mike's comment, this has recently been added.

Answer 6

Clarification: this reply is about access token (not refresh token)

You can configure token expiration from cognito console General Settings / App Clients / {your app} / Show Details / Refresh token expiration (days)

https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html

By default, the refresh token expires 30 days after your app user signs in to your user pool. When you create an app for your user pool, you can set the app's refresh token expiration (in days) to any value between 1 and 3650.

It seems that currently for the web client there is no option for something less than a day (quite strange).

If you use Mobile SDK then

https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html

The Mobile SDK for Android offers the option to change the minimum validity period of the ID and access tokens to a value between 0 and 30 minutes. See the setRefreshThreshold() method of CognitoIdentityProviderClientConfig in the AWS Mobile SDK for Android API Reference.

Answer 7

I presume the question is how to get get granular control of Cognito session termination. There is a way to do this. But first lets recap how Cognito session management works:

1. Auth tokens expire after an hour.
2. A new auth token may be requested upon the issuance of a refresh token.
3. After 1 to 30 days, Cognito will not issue a refresh token - the number of days is configured per app, in the App Client Settings.

So what can you to to get better control of Cognito session length? The answer is to insert a filter in your http request stack that evaluates the request - if the user must be logged out for whatever reason, issue a 302 redirect to the Cognito logout endpoint (and clear your session cookies too).

This is what we do in Kubernetes with Envoy (using a proxy), and also Spring. It also allows you to wire in logic that immediately revokes access to a user before their 1 hour access token expires.

See https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html

Answer 8

Cognito uses the OAuth 2.0 Specification. In order to renew an expired token, you will need to use the Refresh Token value to get a new Id Token.

1. To get authenticated at the start the user id and password are collected from the user and sent to Cognito.
2. You get back two tokens. One you use to "access" the API and one you use to "refresh" when the access expires.
3. You don't need to ask the user to input a user id and password again; you just need to use the "refresh" token.
4. You don't need to store the clear text of the password (which would create a security risk) because the "refresh" token will get you a new access token.

It's really quite simple. Further information in the Cognito documentation to Refresh Tokens