AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

This is a public API. You do not need any credentials to call this API.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to GetOpenIdTokenAsync.

Namespace: Amazon.CognitoIdentity
Assembly: AWSSDK.CognitoIdentity.dll
Version: 3.x.y.z

Syntax

C#
public virtual GetOpenIdTokenResponse GetOpenIdToken(
         GetOpenIdTokenRequest request
)
Parameters
request
Type: Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest

Container for the necessary parameters to execute the GetOpenIdToken service method.

Return Value
The response from the GetOpenIdToken service method, as returned by CognitoIdentity.

Exceptions

ExceptionCondition
ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
InternalErrorException Thrown when the service encounters an error during processing the request.
InvalidParameterException Thrown for missing or bad input parameter(s).
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
TooManyRequestsException Thrown when a request is throttled.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also