ICognitoIdentityGetOpenIdTokenForDeveloperIdentityRequest
Interface in AWS.CognitoIdentity
Interface for GetOpenIdTokenForDeveloperIdentity requests.
Ancestors
Properties
IdentityId
property IdentityId: string
Specify the ID of the identity in the format REGION:GUID.
Do not set this to create a new identity. Set this to an existing IdentityId to associate a new login with an existing authenticated/unauthenticated identity.
IdentityPoolId
property IdentityPoolId: string
Specify the ID of the identity pool in the format REGION:GUID.
Logins
property Logins: TDictionary<string, string>
Specify a set of name-value pairs mapping provider names to provider tokens.
If the user is from a developer provider, the key will be the developer provider name, and the value will be the developer user identifier. The developer provider is the "domain" by which Cognito will refer to your users. The developer provider name will have been specified when creating or updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user.
PrincipalTags
property PrincipalTags: TDictionary<string, string>
Specify attribute mappings for custom providers.
TokenDuration
property TokenDuration: TOptional<Integer>
Specify the expiration time of the token in seconds.
You can provide a custom expiration time for the token so that you can cache it. If not specified, the default token expiration is 15 minutes. You can exchange a token with Amazon STS for temporary AWS credentials which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. Take care when setting the expiration time for a token, as there are significant security implications - attackers could use leaked tokens to access your AWS resources for the token's duration. Note: You should provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
Methods
AddLogin
procedure AddLogin(const AProviderName, AProviderToken: string);
Add a name-value pair to Logins.
Parameters
| Name | Description |
|---|---|
AProviderName | Specify the name of the provider. |
AProviderToken | Specify the token provided by the provider. |
AddPrincipalTag
procedure AddPrincipalTag(const AName, AValue: string);
Add a name-value pair to PrincipalTags
Parameters
| Name | Description |
|---|---|
AName | Specify a principal tag name. |
AValue | Specify a principal tag value. |