PackagesReroutesAboutlamdera.com

canceraiddev/elm-aws-cognito/2.0.0

READMEAboutVersionsSourceModules

AWS.CognitoIdentity

Amazon Cognito Federated Identities

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.

Service definition.

service : Region -> Service

Configuration for this service.

Service endpoints.

createIdentityPool : CreateIdentityPoolInput -> Request AWSAppError IdentityPool

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com

You must use AWS Developer credentials to call this API.

DeleteIdentitiesInput
-> Request AWSAppError DeleteIdentitiesResponse

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

deleteIdentityPool : DeleteIdentityPoolInput -> Request AWSAppError ()

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use AWS Developer credentials to call this API.

describeIdentity : DescribeIdentityInput -> Request AWSAppError IdentityDescription

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

describeIdentityPool : DescribeIdentityPoolInput -> Request AWSAppError IdentityPool

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

GetCredentialsForIdentityInput
-> Request AWSAppError GetCredentialsForIdentityResponse

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

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

getId : GetIdInput -> Request AWSAppError GetIdResponse

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

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

GetIdentityPoolRolesInput
-> Request AWSAppError GetIdentityPoolRolesResponse

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

getOpenIdToken : GetOpenIdTokenInput -> Request AWSAppError GetOpenIdTokenResponse

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 10 minutes.

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

GetOpenIdTokenForDeveloperIdentityInput
-> Request AWSAppError GetOpenIdTokenForDeveloperIdentityResponse

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use AWS Developer credentials to call this API.

listIdentities : ListIdentitiesInput -> Request AWSAppError ListIdentitiesResponse

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

ListIdentityPoolsInput
-> Request AWSAppError ListIdentityPoolsResponse

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

ListTagsForResourceInput
-> Request AWSAppError ListTagsForResourceResponse

Lists the tags that are assigned to an Amazon Cognito identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

LookupDeveloperIdentityInput
-> Request AWSAppError LookupDeveloperIdentityResponse

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.

You must use AWS Developer credentials to call this API.

MergeDeveloperIdentitiesInput
-> Request AWSAppError MergeDeveloperIdentitiesResponse

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use AWS Developer credentials to call this API.

setIdentityPoolRoles : SetIdentityPoolRolesInput -> Request AWSAppError ()

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

tagResource : TagResourceInput -> Request AWSAppError ()

Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

unlinkDeveloperIdentity : UnlinkDeveloperIdentityInput -> Request AWSAppError ()

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use AWS Developer credentials to call this API.

unlinkIdentity : UnlinkIdentityInput -> Request AWSAppError ()

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

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

untagResource : UntagResourceInput -> Request AWSAppError ()

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

updateIdentityPool : IdentityPool -> Request AWSAppError IdentityPool

Updates an identity pool.

You must use AWS Developer credentials to call this API.

API data model.

= AmbiguousRoleResolutionTypeAuthenticatedRole
| AmbiguousRoleResolutionTypeDeny

The AmbiguousRoleResolutionType data model.

{ clientId : Maybe String
, providerName : Maybe String
, serverSideTokenCheck : Maybe Bool
}

The CognitoIdentityProvider data model.

List CognitoIdentityProvider

The CognitoIdentityProviderList data model.

{ allowUnauthenticatedIdentities : Bool
, cognitoIdentityProviders : Maybe CognitoIdentityProviderList
, developerProviderName : Maybe String
, identityPoolName : String
, identityPoolTags : Maybe IdentityPoolTagsType
, openIdConnectProviderArns : Maybe OidcproviderList
, samlProviderArns : Maybe SamlproviderList
, supportedLoginProviders : Maybe IdentityProviders
}

The CreateIdentityPoolInput data model.

type alias Credentials =
{ accessKeyId : Maybe String
, expiration : Maybe Posix
, secretKey : Maybe String
, sessionToken : Maybe String
}

The Credentials data model.

{ identityIdsToDelete : IdentityIdList }

The DeleteIdentitiesInput data model.

{ unprocessedIdentityIds : Maybe UnprocessedIdentityIdList }

The DeleteIdentitiesResponse data model.

{ identityPoolId : String }

The DeleteIdentityPoolInput data model.

{ identityId : String }

The DescribeIdentityInput data model.

{ identityPoolId : String }

The DescribeIdentityPoolInput data model.

List String

The DeveloperUserIdentifierList data model.

= ErrorCodeAccessDenied
| ErrorCodeInternalServerError

The ErrorCode data model.

{ customRoleArn : Maybe String
, identityId : String
, logins : Maybe LoginsMap
}

The GetCredentialsForIdentityInput data model.

{ credentials : Maybe Credentials
, identityId : Maybe String
}

The GetCredentialsForIdentityResponse data model.

type alias GetIdInput =
{ accountId : Maybe String
, identityPoolId : String
, logins : Maybe LoginsMap
}

The GetIdInput data model.

type alias GetIdResponse =
{ identityId : Maybe String }

The GetIdResponse data model.

{ identityPoolId : String }

The GetIdentityPoolRolesInput data model.

{ identityPoolId : Maybe String
, roleMappings : Maybe RoleMappingMap
, roles : Maybe RolesMap
}

The GetIdentityPoolRolesResponse data model.

{ identityId : Maybe String
, identityPoolId : String
, logins : LoginsMap
, tokenDuration : Maybe Int
}

The GetOpenIdTokenForDeveloperIdentityInput data model.

{ identityId : Maybe String
, token : Maybe String
}

The GetOpenIdTokenForDeveloperIdentityResponse data model.

type alias GetOpenIdTokenInput =
{ identityId : String
, logins : Maybe LoginsMap
}

The GetOpenIdTokenInput data model.

{ identityId : Maybe String
, token : Maybe String
}

The GetOpenIdTokenResponse data model.

type alias IdentitiesList =
List IdentityDescription

The IdentitiesList data model.

type alias IdentityDescription =
{ creationDate : Maybe String
, identityId : Maybe String
, lastModifiedDate : Maybe String
, logins : Maybe LoginsList
}

The IdentityDescription data model.

type alias IdentityIdList =
List String

The IdentityIdList data model.

type alias IdentityPool =
{ allowUnauthenticatedIdentities : Bool
, cognitoIdentityProviders : Maybe CognitoIdentityProviderList
, developerProviderName : Maybe String
, identityPoolId : String
, identityPoolName : String
, identityPoolTags : Maybe IdentityPoolTagsType
, openIdConnectProviderArns : Maybe OidcproviderList
, samlProviderArns : Maybe SamlproviderList
, supportedLoginProviders : Maybe IdentityProviders
}

The IdentityPool data model.

{ identityPoolId : Maybe String
, identityPoolName : Maybe String
}

The IdentityPoolShortDescription data model.

List String

The IdentityPoolTagsListType data model.

Dict String String

The IdentityPoolTagsType data model.

type alias IdentityPoolsList =
List IdentityPoolShortDescription

The IdentityPoolsList data model.

type alias IdentityProviders =
Dict String String

The IdentityProviders data model.

type alias ListIdentitiesInput =
{ hideDisabled : Maybe Bool
, identityPoolId : String
, maxResults : Int
, nextToken : Maybe String
}

The ListIdentitiesInput data model.

{ identities : Maybe IdentitiesList
, identityPoolId : Maybe String
, nextToken : Maybe String
}

The ListIdentitiesResponse data model.

{ maxResults : Int
, nextToken : Maybe String
}

The ListIdentityPoolsInput data model.

{ identityPools : Maybe IdentityPoolsList
, nextToken : Maybe String
}

The ListIdentityPoolsResponse data model.

{ resourceArn : String }

The ListTagsForResourceInput data model.

{ tags : Maybe IdentityPoolTagsType }

The ListTagsForResourceResponse data model.

type alias LoginsList =
List String

The LoginsList data model.

type alias LoginsMap =
Dict String String

The LoginsMap data model.

{ developerUserIdentifier : Maybe String
, identityId : Maybe String
, identityPoolId : String
, maxResults : Maybe Int
, nextToken : Maybe String
}

The LookupDeveloperIdentityInput data model.

{ developerUserIdentifierList : Maybe DeveloperUserIdentifierList
, identityId : Maybe String
, nextToken : Maybe String
}

The LookupDeveloperIdentityResponse data model.

type alias MappingRule =
{ claim : String
, matchType : MappingRuleMatchType
, roleArn : String
, value : String
}

The MappingRule data model.

= MappingRuleMatchTypeEquals
| MappingRuleMatchTypeContains
| MappingRuleMatchTypeStartsWith
| MappingRuleMatchTypeNotEqual

The MappingRuleMatchType data model.

type alias MappingRulesList =
List MappingRule

The MappingRulesList data model.

{ destinationUserIdentifier : String
, developerProviderName : String
, identityPoolId : String
, sourceUserIdentifier : String
}

The MergeDeveloperIdentitiesInput data model.

{ identityId : Maybe String }

The MergeDeveloperIdentitiesResponse data model.

type alias OidcproviderList =
List String

The OidcproviderList data model.

type alias RoleMapping =
{ ambiguousRoleResolution : Maybe AmbiguousRoleResolutionType
, rulesConfiguration : Maybe RulesConfigurationType
, type_ : RoleMappingType
}

The RoleMapping data model.

type alias RoleMappingMap =
Dict String RoleMapping

The RoleMappingMap data model.

= RoleMappingTypeToken
| RoleMappingTypeRules

The RoleMappingType data model.

type alias RolesMap =
Dict String String

The RolesMap data model.

{ rules : MappingRulesList }

The RulesConfigurationType data model.

type alias SamlproviderList =
List String

The SamlproviderList data model.

{ identityPoolId : String
, roleMappings : Maybe RoleMappingMap
, roles : RolesMap
}

The SetIdentityPoolRolesInput data model.

type alias TagResourceInput =
{ resourceArn : String
, tags : Maybe IdentityPoolTagsType
}

The TagResourceInput data model.

type alias TagResourceResponse =
{}

The TagResourceResponse data model.

{ developerProviderName : String
, developerUserIdentifier : String
, identityId : String
, identityPoolId : String
}

The UnlinkDeveloperIdentityInput data model.

type alias UnlinkIdentityInput =
{ identityId : String
, logins : LoginsMap
, loginsToRemove : LoginsList
}

The UnlinkIdentityInput data model.

{ errorCode : Maybe ErrorCode
, identityId : Maybe String
}

The UnprocessedIdentityId data model.

List UnprocessedIdentityId

The UnprocessedIdentityIdList data model.

type alias UntagResourceInput =
{ resourceArn : String
, tagKeys : Maybe IdentityPoolTagsListType
}

The UntagResourceInput data model.

{}

The UntagResourceResponse data model.

The AmbiguousRoleResolutionType data model.

The ErrorCode data model.

The MappingRuleMatchType data model.

The RoleMappingType data model.

Modules

About this package serverReroutesreroutes.json
Pages and docs rendering from package.elm-lang.org, © 2012-2020 Evan Czaplicki. © 2026 Lamdera