Merge pull request #60 from firebase/hkj-user-metadata

Use nullable types for UserMetadata fields

Author: hiranya911

CHANGELOG.md

@@ -1,8 +1,7 @@
 # Unreleased
 
-- [added] Implemented the `GetUserById()` API in the `FirebaseUserManager` class.
-
--
+- [added] Implemented the `GetUserAsync()` API in the `FirebaseAuth` class.
+- [added] Implemented the `DeleteUserAsync()` API in the `FirebaseAuth` class.
 
 # v1.4.0
 

FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs

@@ -57,5 +57,57 @@ internal static async Task VeridyIdTokenAsync(string idToken)
             // [END verify_id_token]
             Console.WriteLine("Decoded ID token from user: {0}", uid);
         }
+
+        internal static async Task GetUserAsync(string uid)
+        {
+            // [START get_user_by_id]
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine("Successfully fetched user data: {0}", userRecord.Uid);
+            // [END get_user_by_id]
+        }
+
+        internal static async Task DeleteUserAsync(string uid)
+        {
+            // [START delete_user]
+            await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
+            Console.WriteLine("Successfully deleted user.");
+            // [END delete_user]
+        }
+
+        internal static async Task SetCustomUserClaimsAsync(string uid)
+        {
+            // [START set_custom_user_claims]
+            // Set admin privileges on the user corresponding to uid.
+            var claims = new Dictionary<string, object>()
+            {
+                { "admin", true },
+            };
+            await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(uid, claims);
+            // The new custom claims will propagate to the user's ID token the
+            // next time a new one is issued.
+            // [END set_custom_user_claims]
+
+            var idToken = "id_token";
+            // [START verify_custom_claims]
+            // Verify the ID token first.
+            FirebaseToken decoded = await FirebaseAuth.DefaultInstance.VerifyIdTokenAsync(idToken);
+            object isAdmin;
+            if (decoded.Claims.TryGetValue("admin", out isAdmin))
+            {
+                if ((bool)isAdmin)
+                {
+                    // Allow access to requested admin resource.
+                }
+            }
+
+            // [END verify_custom_claims]
+
+            // [START read_custom_user_claims]
+            // Lookup the user associated with the specified uid.
+            UserRecord user = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
+            Console.WriteLine(user.CustomClaims["admin"]);
+            // [END read_custom_user_claims]
+        }
     }
 }

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -58,8 +58,8 @@ public async Task GetUserById()
             Assert.Equal(UserRecord.UnixEpoch, userRecord.TokensValidAfterTimestamp);
             Assert.Empty(userRecord.CustomClaims);
             Assert.Empty(userRecord.ProviderData);
-            Assert.Equal(DateTime.MinValue, userRecord.UserMetaData.CreationTimestamp);
-            Assert.Equal(DateTime.MinValue, userRecord.UserMetaData.LastSignInTimestamp);
+            Assert.Null(userRecord.UserMetaData.CreationTimestamp);
+            Assert.Null(userRecord.UserMetaData.LastSignInTimestamp);
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin.Tests/Auth/UserRecordTest.cs

@@ -64,8 +64,8 @@ public void UidOnly()
             Assert.Empty(user.CustomClaims);
             Assert.Empty(user.ProviderData);
             Assert.NotNull(user.UserMetaData);
-            Assert.Equal(DateTime.MinValue, user.UserMetaData.CreationTimestamp);
-            Assert.Equal(DateTime.MinValue, user.UserMetaData.LastSignInTimestamp);
+            Assert.Null(user.UserMetaData.CreationTimestamp);
+            Assert.Null(user.UserMetaData.LastSignInTimestamp);
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin/Auth/UserMetadata.cs

@@ -26,27 +26,27 @@ internal UserMetadata(long creationTimestamp, long lastSignInTimestamp)
 
         /// <summary>
         /// Gets a timestamp representing the date and time that the account was created.
-        /// If not available this property is <c>DateTime.MinValue</c>.
+        /// If not available this property is <c>null</c>.
         /// </summary>
-        public DateTime CreationTimestamp
+        public DateTime? CreationTimestamp
         {
             get => this.ToDateTime(this.creationTimestampMillis);
         }
 
         /// <summary>
         /// Gets a timestamp representing the last time that the user has signed in. If the user
-        /// has never signed in this property is <c>DateTime.MinValue</c>.
+        /// has never signed in this property is <c>null</c>.
         /// </summary>
-        public DateTime LastSignInTimestamp
+        public DateTime? LastSignInTimestamp
         {
             get => this.ToDateTime(this.lastSignInTimestampMillis);
         }
 
-        private DateTime ToDateTime(long millisFromEpoch)
+        private DateTime? ToDateTime(long millisFromEpoch)
         {
             if (millisFromEpoch == 0)
             {
-                return DateTime.MinValue;
+                return null;
             }
 
             return UserRecord.UnixEpoch.AddMilliseconds(millisFromEpoch);