cognitoidentity: Amazon Cognito Identity

Description Usage Arguments Service syntax Operations Examples

View source: R/cognitoidentity_service.R

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

Usage

1
cognitoidentity(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- cognitoidentity(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    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) a Cognito ID
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
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
tag_resource Assigns a set of tags to an 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 an Amazon Cognito identity pool
update_identity_pool Updates an identity pool

Examples

1
2
3
4
svc <- cognitoidentity()
svc$create_identity_pool(
  Foo = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.