Amazon Cognito Identity

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

See also: AWS API Documentation

Request Syntax

client.get_principal_tag_attribute_map(
    IdentityPoolId='string',
    IdentityProviderName='string'
)

type IdentityPoolId:

string

param IdentityPoolId:

[REQUIRED]

You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

type IdentityProviderName:

string

param IdentityProviderName:

[REQUIRED]

You can use this operation to get the provider name.

rtype:

dict

returns:

Response Syntax

{
    'IdentityPoolId': 'string',
    'IdentityProviderName': 'string',
    'UseDefaults': True|False,
    'PrincipalTags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • IdentityPoolId (string) --

    You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

  • IdentityProviderName (string) --

    You can use this operation to get the provider name.

  • UseDefaults (boolean) --

    You can use this operation to list

  • PrincipalTags (dict) --

    You can use this operation to add principal tags. The ``PrincipalTags``operation enables you to reference user attributes in your IAM permissions policy.

    • (string) --

      • (string) --

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

See also: AWS API Documentation

Request Syntax

client.set_principal_tag_attribute_map(
    IdentityPoolId='string',
    IdentityProviderName='string',
    UseDefaults=True|False,
    PrincipalTags={
        'string': 'string'
    }
)

type IdentityPoolId:

string

param IdentityPoolId:

[REQUIRED]

The ID of the Identity Pool you want to set attribute mappings for.

type IdentityProviderName:

string

param IdentityProviderName:

[REQUIRED]

The provider name you want to use for attribute mappings.

type UseDefaults:

boolean

param UseDefaults:

You can use this operation to use default (username and clientID) attribute mappings.

type PrincipalTags:

dict

param PrincipalTags:

You can use this operation to add principal tags.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'IdentityPoolId': 'string',
    'IdentityProviderName': 'string',
    'UseDefaults': True|False,
    'PrincipalTags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • IdentityPoolId (string) --

    The ID of the Identity Pool you want to set attribute mappings for.

  • IdentityProviderName (string) --

    The provider name you want to use for attribute mappings.

  • UseDefaults (boolean) --

    You can use this operation to select default (username and clientID) attribute mappings.

  • PrincipalTags (dict) --

    You can use this operation to add principal tags. The ``PrincipalTags``operation enables you to reference user attributes in your IAM permissions policy.

    • (string) --

      • (string) --

{'PrincipalTags': {'string': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.get_open_id_token_for_developer_identity(
    IdentityPoolId='string',
    IdentityId='string',
    Logins={
        'string': 'string'
    },
    PrincipalTags={
        'string': 'string'
    },
    TokenDuration=123
)

type IdentityPoolId:

string

param IdentityPoolId:

[REQUIRED]

An identity pool ID in the format REGION:GUID.

type IdentityId:

string

param IdentityId:

A unique identifier in the format REGION:GUID.

type Logins:

dict

param Logins:

[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) --

type PrincipalTags:

dict

param PrincipalTags:

Use this operation to configure attribute mappings for custom providers.

• (string) --

  • (string) --

type TokenDuration:

integer

param TokenDuration:

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.

rtype:

dict

returns:

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.