Container for the parameters to the GetCredentialsForIdentity operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentity.AmazonCognitoIdentityRequest
Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest
Namespace: Amazon.CognitoIdentity.Model
Assembly: AWSSDK.CognitoIdentity.dll
Version: 3.x.y.z
Syntax
public class GetCredentialsForIdentityRequest : AmazonCognitoIdentityRequest IAmazonWebServiceRequest
The GetCredentialsForIdentityRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetCredentialsForIdentityRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CustomRoleArn | System.String |
Gets and sets the property CustomRoleArn. 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. |
|
|
IdentityId | System.String |
Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. |
|
|
Logins | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Logins. 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 |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5