AuthenticationResultType - Amazon Cognito User Pools
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AuthenticationResultType

The object that your application receives after authentication. Contains tokens and information for device authentication.

This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

Contents

AccessToken

Your user's access token.

Type: String

Pattern: [A-Za-z0-9-_=.]+

Required: No

ExpiresIn

The expiration period of the authentication result in seconds.

Type: Integer

Required: No

IdToken

Your user's ID token.

Type: String

Pattern: [A-Za-z0-9-_=.]+

Required: No

NewDeviceMetadata

The new device metadata from an authentication result.

Type: NewDeviceMetadataType object

Required: No

RefreshToken

Your user's refresh token.

Type: String

Pattern: [A-Za-z0-9-_=.]+

Required: No

TokenType

The intended use of the token, for example Bearer.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: