Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-identity ]

get-credentials-for-identity

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-credentials-for-identity
--identity-id <value>
[--logins <value>]
[--custom-role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--identity-id (string)

A unique identifier in the format REGION:GUID.

--logins (map)

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as FaceBook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--custom-role-arn (string)

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

IdentityId -> (string)

A unique identifier in the format REGION:GUID.

Credentials -> (structure)

Credentials for 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 -> (timestamp)

The date at which these credentials will expire.