Expand description
Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, 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.
For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.
For more information see Amazon Cognito Federated Identities.
If you’re using the service, you’re probably looking for CognitoIdentityClient and CognitoIdentity.
Structs§
- Cognito
Identity Client - A client for the Amazon Cognito Identity API.
- Cognito
Identity Provider A provider representing an Amazon Cognito user pool and its client ID.
- Cognito
Provider - Provides AWS credentials from aws Cognito.
- Cognito
Provider Builder A builder for the Cognito credential provider.
- Create
Identity Pool Input Input to the CreateIdentityPool action.
- Credentials
Credentials for the provided identity ID.
- Delete
Identities Input Input to the
DeleteIdentitiesaction.- Delete
Identities Response Returned in response to a successful
DeleteIdentitiesoperation.- Delete
Identity Pool Input Input to the DeleteIdentityPool action.
- Describe
Identity Input Input to the
DescribeIdentityaction.- Describe
Identity Pool Input Input to the DescribeIdentityPool action.
- GetCredentials
ForIdentity Input Input to the
GetCredentialsForIdentityaction.- GetCredentials
ForIdentity Response Returned in response to a successful
GetCredentialsForIdentityoperation.- GetId
Input Input to the GetId action.
- GetId
Response Returned in response to a GetId request.
- GetIdentity
Pool Roles Input Input to the
GetIdentityPoolRolesaction.- GetIdentity
Pool Roles Response Returned in response to a successful
GetIdentityPoolRolesoperation.- GetOpen
IdToken ForDeveloper Identity Input Input to the
GetOpenIdTokenForDeveloperIdentityaction.- GetOpen
IdToken ForDeveloper Identity Response Returned in response to a successful
GetOpenIdTokenForDeveloperIdentityrequest.- GetOpen
IdToken Input Input to the GetOpenIdToken action.
- GetOpen
IdToken Response Returned in response to a successful GetOpenIdToken request.
- GetPrincipal
TagAttribute MapInput - GetPrincipal
TagAttribute MapResponse - Identity
Description A description of the identity.
- Identity
Pool An object representing an Amazon Cognito identity pool.
- Identity
Pool Short Description A description of the identity pool.
- List
Identities Input Input to the ListIdentities action.
- List
Identities Response The response to a ListIdentities request.
- List
Identity Pools Input Input to the ListIdentityPools action.
- List
Identity Pools Response The result of a successful ListIdentityPools action.
- List
Tags ForResource Input - List
Tags ForResource Response - Lookup
Developer Identity Input Input to the
LookupDeveloperIdentityInputaction.- Lookup
Developer Identity Response Returned in response to a successful
LookupDeveloperIdentityaction.- Mapping
Rule A rule that maps a claim name, a claim value, and a match type to a role ARN.
- Merge
Developer Identities Input Input to the
MergeDeveloperIdentitiesaction.- Merge
Developer Identities Response Returned in response to a successful
MergeDeveloperIdentitiesaction.- Role
Mapping A role mapping.
- Rules
Configuration Type A container for rules.
- SetIdentity
Pool Roles Input Input to the
SetIdentityPoolRolesaction.- SetPrincipal
TagAttribute MapInput - SetPrincipal
TagAttribute MapResponse - TagResource
Input - TagResource
Response - Unlink
Developer Identity Input Input to the
UnlinkDeveloperIdentityaction.- Unlink
Identity Input Input to the UnlinkIdentity action.
- Unprocessed
Identity Id An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
- Untag
Resource Input - Untag
Resource Response
Enums§
- Create
Identity Pool Error - Errors returned by CreateIdentityPool
- Delete
Identities Error - Errors returned by DeleteIdentities
- Delete
Identity Pool Error - Errors returned by DeleteIdentityPool
- Describe
Identity Error - Errors returned by DescribeIdentity
- Describe
Identity Pool Error - Errors returned by DescribeIdentityPool
- GetCredentials
ForIdentity Error - Errors returned by GetCredentialsForIdentity
- GetId
Error - Errors returned by GetId
- GetIdentity
Pool Roles Error - Errors returned by GetIdentityPoolRoles
- GetOpen
IdToken Error - Errors returned by GetOpenIdToken
- GetOpen
IdToken ForDeveloper Identity Error - Errors returned by GetOpenIdTokenForDeveloperIdentity
- GetPrincipal
TagAttribute MapError - Errors returned by GetPrincipalTagAttributeMap
- List
Identities Error - Errors returned by ListIdentities
- List
Identity Pools Error - Errors returned by ListIdentityPools
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Lookup
Developer Identity Error - Errors returned by LookupDeveloperIdentity
- Merge
Developer Identities Error - Errors returned by MergeDeveloperIdentities
- SetIdentity
Pool Roles Error - Errors returned by SetIdentityPoolRoles
- SetPrincipal
TagAttribute MapError - Errors returned by SetPrincipalTagAttributeMap
- TagResource
Error - Errors returned by TagResource
- Unlink
Developer Identity Error - Errors returned by UnlinkDeveloperIdentity
- Unlink
Identity Error - Errors returned by UnlinkIdentity
- Untag
Resource Error - Errors returned by UntagResource
- Update
Identity Pool Error - Errors returned by UpdateIdentityPool
Traits§
- Cognito
Identity - Trait representing the capabilities of the Amazon Cognito Identity API. Amazon Cognito Identity clients implement this trait.