2015/05/07 - Amazon Cognito Identity - 17 new api methods
Returns credentials for the 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.
Request Syntax
client.get_credentials_for_identity(
IdentityId='string',
Logins={
'string': 'string'
}
)
string
[REQUIRED]
A unique identifier in the format REGION:GUID.
dict
A set of optional name-value pairs that map provider names to provider tokens.
(string) --
(string) --
dict
Response Syntax
{
'IdentityId': 'string',
'Credentials': {
'AccessKeyId': 'string',
'SecretKey': 'string',
'SessionToken': 'string',
'Expiration': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Returned in response to a successful GetCredentialsForIdentity operation.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Credentials (dict) --
Credentials for the the provided identity ID.
AccessKeyId (string) --
The Access Key portion of the credentials.
SecretKey (string) --
The Secret Access Key portion of the credentials
SessionToken (string) --
The Session Token portion of the credentials
Expiration (datetime) --
The date at which these credentials will expire.
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.
Request Syntax
client.create_identity_pool(
IdentityPoolName='string',
AllowUnauthenticatedIdentities=True|False,
SupportedLoginProviders={
'string': 'string'
},
DeveloperProviderName='string',
OpenIdConnectProviderARNs=[
'string',
]
)
string
[REQUIRED]
A string that you provide.
boolean
[REQUIRED]
TRUE if the identity pool supports unauthenticated logins.
dict
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
string
The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period ( .), underscore ( _), and dash ( -).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
list
A list of OpendID Connect provider ARNs.
(string) --
dict
Response Syntax
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
]
}
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
A list of OpendID Connect provider ARNs.
(string) --
Gets the roles for an identity pool.
Request Syntax
client.get_identity_pool_roles(
IdentityPoolId='string'
)
string
An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'Roles': {
'string': 'string'
}
}
Response Structure
(dict) --
Returned in response to a successful GetIdentityPoolRoles operation.
IdentityPoolId (string) --
An identity pool ID in the format REGION:GUID.
Roles (dict) --
The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
(string) --
(string) --
Lists all of the Cognito identity pools registered for your account.
Request Syntax
client.list_identity_pools(
MaxResults=123,
NextToken='string'
)
integer
[REQUIRED] The maximum number of identities to return.
string
A pagination token.
dict
Response Syntax
{
'IdentityPools': [
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- The result of a successful ListIdentityPools action.
IdentityPools (list) -- The identity pools returned by the ListIdentityPools action.
(dict) -- A description of the identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) -- A string that you provide.
NextToken (string) -- A pagination token.
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
Request Syntax
client.get_id(
AccountId='string',
IdentityPoolId='string',
Logins={
'string': 'string'
}
)
string
A standard AWS account ID (9+ digits).
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
dict
A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
Facebook: graph.facebook.com
Google: accounts.google.com
Amazon: www.amazon.com
(string) --
(string) --
dict
Response Syntax
{
'IdentityId': 'string'
}
Response Structure
(dict) -- Returned in response to a GetId request.
IdentityId (string) -- A unique identifier in the format REGION:GUID.
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier``s 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.
Request Syntax
client.lookup_developer_identity(
IdentityPoolId='string',
IdentityId='string',
DeveloperUserIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
An identity pool ID in the format REGION:GUID.
string
A unique identifier in the format REGION:GUID.
string
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
integer
The maximum number of identities to return.
string
A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
dict
Response Syntax
{
'IdentityId': 'string',
'DeveloperUserIdentifierList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Returned in response to a successful LookupDeveloperIdentity action.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
DeveloperUserIdentifierList (list) --
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
(string) --
NextToken (string) --
A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
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.
Request Syntax
client.unlink_identity(
IdentityId='string',
Logins={
'string': 'string'
},
LoginsToRemove=[
'string',
]
)
string
[REQUIRED] A unique identifier in the format REGION:GUID.
dict
[REQUIRED] A set of optional name-value pairs that map provider names to provider tokens.
(string) --
(string) --
list
[REQUIRED] Provider names to unlink from this identity.
(string) --
None
Merges two users having different IdentityId``s, 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.
Request Syntax
client.merge_developer_identities(
SourceUserIdentifier='string',
DestinationUserIdentifier='string',
DeveloperProviderName='string',
IdentityPoolId='string'
)
string
[REQUIRED]
User identifier for the source user. The value should be a DeveloperUserIdentifier.
string
[REQUIRED]
User identifier for the destination user. The value should be a DeveloperUserIdentifier.
string
[REQUIRED]
The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
string
[REQUIRED]
An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{
'IdentityId': 'string'
}
Response Structure
(dict) --
Returned in response to a successful MergeDeveloperIdentities action.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
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.
Request Syntax
client.get_open_id_token(
IdentityId='string',
Logins={
'string': 'string'
}
)
string
[REQUIRED] A unique identifier in the format REGION:GUID.
dict
A set of optional name-value pairs that map provider names to provider tokens.
(string) --
(string) --
dict
Response Syntax
{
'IdentityId': 'string',
'Token': 'string'
}
Response Structure
(dict) -- Returned in response to a successful GetOpenIdToken request.
IdentityId (string) -- A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
Token (string) -- An OpenID token, valid for 15 minutes.
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
Request Syntax
client.describe_identity(
IdentityId='string'
)
string
[REQUIRED]
A unique identifier in the format REGION:GUID.
dict
Response Syntax
{
'IdentityId': 'string',
'Logins': [
'string',
],
'CreationDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) -- A description of the identity.
IdentityId (string) -- A unique identifier in the format REGION:GUID.
Logins (list) -- A set of optional name-value pairs that map provider names to provider tokens.
(string) --
CreationDate (datetime) --
Date on which the identity was created.
LastModifiedDate (datetime) --
Date on which the identity was last modified.
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.
Request Syntax
client.get_open_id_token_for_developer_identity(
IdentityPoolId='string',
IdentityId='string',
Logins={
'string': 'string'
},
TokenDuration=123
)
string
[REQUIRED]
An identity pool ID in the format REGION:GUID.
string
A unique identifier in the format REGION:GUID.
dict
[REQUIRED]
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
(string) --
(string) --
integer
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
dict
Response Syntax
{
'IdentityId': 'string',
'Token': 'string'
}
Response Structure
(dict) --
Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Token (string) --
An OpenID token.
Lists the identities in a pool.
Request Syntax
client.list_identities(
IdentityPoolId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
integer
[REQUIRED] The maximum number of identities to return.
string
A pagination token.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'Identities': [
{
'IdentityId': 'string',
'Logins': [
'string',
],
'CreationDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- The response to a ListIdentities request.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
Identities (list) -- An object containing a set of identities and associated mappings.
(dict) -- A description of the identity.
IdentityId (string) -- A unique identifier in the format REGION:GUID.
Logins (list) -- A set of optional name-value pairs that map provider names to provider tokens.
(string) --
CreationDate (datetime) --
Date on which the identity was created.
LastModifiedDate (datetime) --
Date on which the identity was last modified.
NextToken (string) -- A pagination token.
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
Request Syntax
client.delete_identity_pool(
IdentityPoolId='string'
)
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
None
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
Request Syntax
client.set_identity_pool_roles(
IdentityPoolId='string',
Roles={
'string': 'string'
}
)
string
[REQUIRED]
An identity pool ID in the format REGION:GUID.
dict
[REQUIRED]
The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
(string) --
(string) --
None
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.
Request Syntax
client.unlink_developer_identity(
IdentityId='string',
IdentityPoolId='string',
DeveloperProviderName='string',
DeveloperUserIdentifier='string'
)
string
[REQUIRED]
A unique identifier in the format REGION:GUID.
string
[REQUIRED]
An identity pool ID in the format REGION:GUID.
string
[REQUIRED]
The "domain" by which Cognito will refer to your users.
string
[REQUIRED] A unique ID used by your backend authentication process to identify a user.
None
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
Request Syntax
client.describe_identity_pool(
IdentityPoolId='string'
)
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
]
}
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
A list of OpendID Connect provider ARNs.
(string) --
Updates a user pool.
Request Syntax
client.update_identity_pool(
IdentityPoolId='string',
IdentityPoolName='string',
AllowUnauthenticatedIdentities=True|False,
SupportedLoginProviders={
'string': 'string'
},
DeveloperProviderName='string',
OpenIdConnectProviderARNs=[
'string',
]
)
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
string
[REQUIRED]
A string that you provide.
boolean
[REQUIRED] TRUE if the identity pool supports unauthenticated logins.
dict
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
string
The "domain" by which Cognito will refer to your users.
list
A list of OpendID Connect provider ARNs.
(string) --
dict
Response Syntax
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
]
}
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
A list of OpendID Connect provider ARNs.
(string) --