Implementing cognito trigger events

PreSignup
PostConfirmation
PreAuthentication
PostAuthentication
DefineAuthChallenge
CreateAuthChallenge
VerifyAuthChallenge
PreTokenGeneration
MigrateUser
CustomMessage
CustomEmailSender
CustomSmsSender

Author: jon-armen

Libraries/src/Amazon.Lambda.CognitoEvents/Amazon.Lambda.CognitoEvents.csproj

@@ -4,7 +4,7 @@
 
   <PropertyGroup>
     <Description>Amazon Lambda .NET Core support - CognitoEvents package.</Description>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFrameworks>netstandard2.0;netcoreapp3.1</TargetFrameworks>
     <AssemblyTitle>Amazon.Lambda.CognitoEvents</AssemblyTitle>
     <VersionPrefix>2.0.0</VersionPrefix>
     <AssemblyName>Amazon.Lambda.CognitoEvents</AssemblyName>

Libraries/src/Amazon.Lambda.CognitoEvents/ChallengeResultElement.cs

@@ -0,0 +1,38 @@
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-define-auth-challenge.html
+    /// </summary>
+    [DataContract]
+    public class ChallengeResultElement
+    {
+        /// <summary>
+        /// The challenge type.One of: CUSTOM_CHALLENGE, SRP_A, PASSWORD_VERIFIER, SMS_MFA, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, or ADMIN_NO_SRP_AUTH.
+        /// </summary>
+        [DataMember(Name = "challengeName")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("challengeName")]
+# endif
+        public string ChallengeName { get; set; }
+
+        /// <summary>
+        /// Set to true if the user successfully completed the challenge, or false otherwise.
+        /// </summary>
+        [DataMember(Name = "challengeResult")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("challengeResult")]
+# endif
+        public bool ChallengeResult { get; set; }
+
+        /// <summary>
+        /// Your name for the custom challenge.Used only if challengeName is CUSTOM_CHALLENGE.
+        /// </summary>
+        [DataMember(Name = "challengeMetadata")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("challengeMetadata")]
+# endif
+        public string ChallengeMetadata { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/ClaimOverrideDetails.cs

@@ -0,0 +1,39 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html
+    /// </summary>
+    [DataContract]
+    public class ClaimOverrideDetails
+    {
+        /// <summary>
+        /// A map of one or more key-value pairs of claims to add or override. For group related claims, use groupOverrideDetails instead.
+        /// </summary>
+        [DataMember(Name = "claimsToAddOrOverride")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("claimsToAddOrOverride")]
+# endif
+        public Dictionary<string, string> ClaimsToAddOrOverride { get; set; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// A list that contains claims to be suppressed from the identity token.
+        /// </summary>
+        [DataMember(Name = "claimsToSuppress")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("claimsToSuppress")]
+# endif
+        public List<string> ClaimsToSuppress { get; set; } = new List<string>();
+
+        /// <summary>
+        /// The output object containing the current group configuration. It includes groupsToOverride, iamRolesToOverride, and preferredRole.
+        /// </summary>
+        [DataMember(Name = "groupOverrideDetails")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("groupOverrideDetails")]
+# endif
+        public GroupConfiguration GroupOverrideDetails { get; set; } = new GroupConfiguration();
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCreateAuthChallengeEvent.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html
+    /// </summary>
+    public class CognitoCreateAuthChallengeEvent : CognitoTriggerEvent<CognitoCreateAuthChallengeRequest, CognitoCreateAuthChallengeResponse>
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCreateAuthChallengeRequest.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html
+    /// </summary>
+    public class CognitoCreateAuthChallengeRequest : CognitoTriggerRequest
+    {
+        /// <summary>
+        /// One or more key-value pairs that you can provide as custom input to the Lambda function that you specify for the pre sign-up trigger. You can pass this data to your Lambda function by using the ClientMetadata parameter in the following API actions: AdminCreateUser, AdminRespondToAuthChallenge, ForgotPassword, and SignUp.
+        /// </summary>
+        [DataMember(Name = "clientMetadata")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("clientMetadata")]
+# endif
+        public Dictionary<string, string> ClientMetadata { get; set; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// The name of the new challenge.
+        /// </summary>
+        [DataMember(Name = "challengeName")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("challengeName")]
+#endif
+        public string ChallengeName { get; set; }
+
+        /// <summary>
+        /// an array of ChallengeResult elements
+        /// </summary>
+        [DataMember(Name = "session")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("session")]
+#endif
+        public List<ChallengeResultElement> Session { get; set; } = new List<ChallengeResultElement>();
+
+        /// <summary>
+        /// A Boolean that is populated when PreventUserExistenceErrors is set to ENABLED for your user pool client. A value of true means that the user id (user name, email address, etc.) did not match any existing users. When PreventUserExistenceErrors is set to ENABLED, the service will not report back to the app that the user does not exist. The recommended best practice is for your Lambda functions to maintain the same user experience including latency so the caller cannot detect different behavior when the user exists or doesn’t exist.
+        /// </summary>
+        [DataMember(Name = "userNotFound")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("userNotFound")]
+#endif
+        public bool UserNotFound { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCreateAuthChallengeResponse.cs

@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html
+    /// </summary>
+    public class CognitoCreateAuthChallengeResponse : CognitoTriggerResponse
+    {
+        /// <summary>
+        /// One or more key-value pairs for the client app to use in the challenge to be presented to the user.This parameter should contain all of the necessary information to accurately present the challenge to the user.
+        /// </summary>
+        [DataMember(Name = "publicChallengeParameters")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("publicChallengeParameters")]
+#endif
+        public Dictionary<string, string> PublicChallengeParameters { get; set; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// This parameter is only used by the Verify Auth Challenge Response Lambda trigger. This parameter should contain all of the information that is required to validate the user's response to the challenge. In other words, the publicChallengeParameters parameter contains the question that is presented to the user and privateChallengeParameters contains the valid answers for the question.
+        /// </summary>
+        [DataMember(Name = "privateChallengeParameters")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("privateChallengeParameters")]
+#endif
+        public Dictionary<string, string> PrivateChallengeParameters { get; set; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// Your name for the custom challenge, if this is a custom challenge.
+        /// </summary>
+        [DataMember(Name = "challengeMetadata")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("challengeMetadata")]
+#endif
+        public string ChallengeMetadata { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomEmailSenderEvent.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html
+    /// </summary>
+    public class CognitoCustomEmailSenderEvent : CognitoTriggerEvent<CognitoCustomEmailSenderRequest, CognitoCustomEmailSenderResponse>
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomEmailSenderRequest.cs

@@ -0,0 +1,28 @@
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html
+    /// </summary>
+    public class CognitoCustomEmailSenderRequest : CognitoTriggerRequest
+    {
+        /// <summary>
+        /// The type of sender request.
+        /// </summary>
+        [DataMember(Name = "type")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("type")]
+# endif
+        public string Type { get; set; }
+
+        /// <summary>
+        /// The encrypted temporary authorization code.
+        /// </summary>
+        [DataMember(Name = "code")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("code")]
+#endif
+        public string Code { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomEmailSenderResponse.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html
+    /// </summary>
+    public class CognitoCustomEmailSenderResponse : CognitoTriggerResponse
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomMessageEvent.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html
+    /// </summary>
+    public class CognitoCustomMessageEvent : CognitoTriggerEvent<CognitoCustomMessageRequest, CognitoCustomMessageResponse>
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomMessageRequest.cs

@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html
+    /// </summary>
+    public class CognitoCustomMessageRequest : CognitoTriggerRequest
+    {
+        /// <summary>
+        /// A string for you to use as the placeholder for the verification code in the custom message.
+        /// </summary>
+        [DataMember(Name = "codeParameter")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("codeParameter")]
+#endif
+        public string CodeParameter { get; set; }
+
+        /// <summary>
+        /// The username parameter. It is a required request parameter for the admin create user flow.
+        /// </summary>
+        [DataMember(Name = "usernameParameter")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("usernameParameter")]
+#endif
+        public string UsernameParameter { get; set; }
+
+        /// <summary>
+        /// One or more key-value pairs that you can provide as custom input to the Lambda function that you specify for the pre sign-up trigger. You can pass this data to your Lambda function by using the ClientMetadata parameter in the following API actions: AdminCreateUser, AdminRespondToAuthChallenge, ForgotPassword, and SignUp.
+        /// </summary>
+        [DataMember(Name = "clientMetadata")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("clientMetadata")]
+#endif
+        public Dictionary<string, string> ClientMetadata { get; set; } = new Dictionary<string, string>();
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomMessageResponse.cs

@@ -0,0 +1,37 @@
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html
+    /// </summary>
+    public class CognitoCustomMessageResponse : CognitoTriggerResponse
+    {
+        /// <summary>
+        /// The custom SMS message to be sent to your users. Must include the codeParameter value received in the request.
+        /// </summary>
+        [DataMember(Name = "smsMessage")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("smsMessage")]
+#endif
+        public string SmsMessage { get; set; }
+
+        /// <summary>
+        /// The custom email message to be sent to your users. Must include the codeParameter value received in the request.
+        /// </summary>
+        [DataMember(Name = "emailMessage")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("emailMessage")]
+#endif
+        public string EmailMessage { get; set; }
+
+        /// <summary>
+        /// The subject line for the custom message.
+        /// </summary>
+        [DataMember(Name = "emailSubject")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("emailSubject")]
+#endif
+        public string EmailSubject { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomSmsSenderEvent.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html
+    /// </summary>
+    public class CognitoCustomSmsSenderEvent : CognitoTriggerEvent<CognitoCustomSmsSenderRequest, CognitoCustomSmsSenderResponse>
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomSmsSenderRequest.cs

@@ -0,0 +1,28 @@
+using System.Runtime.Serialization;
+
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html
+    /// </summary>
+    public class CognitoCustomSmsSenderRequest : CognitoTriggerRequest
+    {
+        /// <summary>
+        /// The type of sender request.
+        /// </summary>
+        [DataMember(Name = "type")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("type")]
+#endif
+        public string Type { get; set; }
+
+        /// <summary>
+        /// The encrypted temporary authorization code.
+        /// </summary>
+        [DataMember(Name = "code")]
+#if NETCOREAPP3_1
+        [System.Text.Json.Serialization.JsonPropertyName("code")]
+#endif
+        public string Code { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoCustomSmsSenderResponse.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html
+    /// </summary>
+    public class CognitoCustomSmsSenderResponse : CognitoTriggerResponse
+    {
+    }
+}

Libraries/src/Amazon.Lambda.CognitoEvents/CognitoDefineAuthChallengeEvent.cs

@@ -0,0 +1,9 @@
+namespace Amazon.Lambda.CognitoEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-define-auth-challenge.html
+    /// </summary>
+    public class CognitoDefineAuthChallengeEvent : CognitoTriggerEvent<CognitoDefineAuthChallengeRequest, CognitoDefineAuthChallengeResponse>
+    {
+    }
+}