Amazon Cognito Federated Identities
API Reference (API Version 2014-06-30)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CognitoIdentityProvider

A provider representing an Amazon Cognito user pool and its client ID.

Contents

ClientId

The client ID for the Amazon Cognito user pool.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w_]+

Required: No

ProviderName

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w._:/-]+

Required: No

ServerSideTokenCheck

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Type: Boolean

Required: No

See Also

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

On this page: