Skip to main content

ICognitoIdentityGetCredentialsForIdentityRequest

Interface in AWS.CognitoIdentity

Interface for GetCredentialsForIdentity requests.

Ancestors

Properties

CustomRoleArn

property CustomRoleArn: TARN

Specify the Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider.

This is optional for identity providers that don't support role customization.

IdentityId

property IdentityId: string

Specify the unique identifier for the identity in the format REGION:GUID.

Logins

property Logins: TDictionary<string, string>

Specify a set of name-value pairs mapping provider names to provider tokens.

Logins should not be specified when trying to get credentials for an unauthenticated identity. The logins parameter is required when using identities associated with an external identity provider such as Facebook.

Methods

AddLogin

procedure AddLogin(const AProviderName, AProviderIdentifier: string);

Add a name-value pair to Logins.

Parameters

NameDescription
AProviderNameSpecify the name of the provider.
AProviderIdentifierSpecify the identifier provided by the provider.