ICognitoIdentityProviderInitiateAuthRequest
Interface in AWS.CognitoIdentityProvider
Interface for InitiateAuth requests.
Ancestors
Properties
AnalyticsMetadata
property AnalyticsMetadata: ICognitoIdentityProviderAnalyticsMetadataType
Type: ICognitoIdentityProviderAnalyticsMetadataType
Specify configuration for analytics metadata collection for Amazon Pinpoint metrics.
AuthFlow
property AuthFlow: string
Specify the authentication flow to run.
Valid values:
AuthParameters
property AuthParameters: TDictionary<string, string>
Specify authentication parameters.
The required values depend on the value of AuthFlow:
ClientId
property ClientId: string
Specify the ID of the app client.
ClientMetadata
property ClientMetadata: TDictionary<string, string>
Specify a custom map of key-value pairs that you can provide as input for certain custom workflows triggered by this action.
UserContextData
property UserContextData: ICognitoIdentityProviderUserContextDataType
Type: ICognitoIdentityProviderUserContextDataType
Contextual data about the user session, such as the device fingerprint, IP address, or location.
Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito.
Methods
AddAuthParameter
procedure AddAuthParameter(const AName, AValue: string);
Add a name-value pair to AuthParameters.
Parameters
| Name | Description |
|---|---|
AName | Specify the name of the parameter. |
AValue | Specify the value of the parameter. |
AddClientMetadata
procedure AddClientMetadata(const AKey, AValue: string);
Add a key-value pair to ClientMetadata.
Parameters
| Name | Description |
|---|---|
AKey | Specify the key of the metadata. |
AValue | Specify the value of the metadata. |