Amazon Cognito Identity¶

Description¶

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 Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services 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.

Usage¶

cognitoidentity(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cognitoidentity(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`create_identity_pool`	Creates a new identity pool
`delete_identities`	Deletes identities from an identity pool
`delete_identity_pool`	Deletes an identity pool
`describe_identity`	Returns metadata related to the given identity, including when the identity was created and any associated linked logins
`describe_identity_pool`	Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users
`get_credentials_for_identity`	Returns credentials for the provided identity ID
`get_id`	Generates (or retrieves) IdentityID
`get_identity_pool_roles`	Gets the roles for an identity pool
`get_open_id_token`	Gets an OpenID token, using a known Cognito ID
`get_open_id_token_for_developer_identity`	Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process
`get_principal_tag_attribute_map`	Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes
`list_identities`	Lists the identities in an identity pool
`list_identity_pools`	Lists all of the Cognito identity pools registered for your account
`list_tags_for_resource`	Lists the tags that are assigned to an Amazon Cognito identity pool
`lookup_developer_identity`	Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity
`merge_developer_identities`	Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider
`set_identity_pool_roles`	Sets the roles for an identity pool
`set_principal_tag_attribute_map`	You can use this operation to use default (username and clientID) attribute or custom attribute mappings
`tag_resource`	Assigns a set of tags to the specified Amazon Cognito identity pool
`unlink_developer_identity`	Unlinks a DeveloperUserIdentifier from an existing identity
`unlink_identity`	Unlinks a federated identity from an existing account
`untag_resource`	Removes the specified tags from the specified Amazon Cognito identity pool
`update_identity_pool`	Updates the configuration of an identity pool

Examples¶

svc <- cognitoidentity()
svc$create_identity_pool(
  Foo = 123
)