com.amazonaws.services.cognitoidentity.package-info Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidentity Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
/**
* Amazon Cognito
*
* Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted
* environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the
* lifetime of an application.
*
*
* Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook,
* Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito
* delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service
* (STS) to access temporary, limited-privilege AWS credentials.
*
*
* To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with
* one of the supported identity providers, set the Logins map with the identity provider token.
* GetId returns a unique identifier for the user.
*
*
* Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map
* as the GetId call, as well as the IdentityID originally returned by GetId.
* Assuming your identity pool has been configured via the SetIdentityPoolRoles operation,
* GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured
* with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to
* GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call
* expects the same Logins map as the GetId call, as well as the IdentityID
* originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS
* operation
* AssumeRoleWithWebIdentity to retrieve AWS credentials.
*
*
* If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls
* via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK
* Developer Guide.
*
*/
package com.amazonaws.services.cognitoidentity;