Merge pull request #81 from firebase/hkj-auth-snippets

Added snippets for new user management APIs

Author: hiranya911

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+- [added] Implemented the `ListUsersAsync()` API.
 - [added] Implemented the `UpdateUserAsync()` API.
 - [added] Implemented the `CreateUserAsync()` and `UserRecordArgs` APIs.
 

FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs

@@ -63,7 +63,7 @@ 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);
+            Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");
             // [END get_user_by_id]
         }
 
@@ -72,7 +72,7 @@ internal static async Task GetUserByEmailAsync(string email)
             // [START get_user_by_email]
             UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
             // See the UserRecord reference doc for the contents of userRecord.
-            Console.WriteLine("Successfully fetched user data: {0}", userRecord.Uid);
+            Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");
             // [END get_user_by_email]
         }
 
@@ -81,10 +81,64 @@ internal static async Task GetUserByPhoneNumberAsync(string phoneNumber)
             // [START get_user_by_phone]
             UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
             // See the UserRecord reference doc for the contents of userRecord.
-            Console.WriteLine("Successfully fetched user data: {0}", userRecord.Uid);
+            Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");
             // [END get_user_by_phone]
         }
 
+        internal static async Task CreateUserAsync()
+        {
+            // [START create_user]
+            UserRecordArgs args = new UserRecordArgs()
+            {
+                Email = "[email protected]",
+                EmailVerified = false,
+                PhoneNumber = "+11234567890",
+                Password = "secretPassword",
+                DisplayName = "John Doe",
+                PhotoUrl = "http://www.example.com/12345678/photo.png",
+                Disabled = false,
+            };
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine($"Successfully created new user: {userRecord.Uid}");
+            // [END create_user]
+        }
+
+        internal static async Task CreateUserWithUidAsync()
+        {
+            // [START create_user_with_uid]
+            UserRecordArgs args = new UserRecordArgs()
+            {
+                Uid = "some-uid",
+                Email = "[email protected]",
+                PhoneNumber = "+11234567890",
+            };
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine($"Successfully created new user: {userRecord.Uid}");
+            // [END create_user_with_uid]
+        }
+
+        internal static async Task UpdateUserAsync(string uid)
+        {
+            // [START update_user]
+            UserRecordArgs args = new UserRecordArgs()
+            {
+                Uid = uid,
+                Email = "[email protected]",
+                PhoneNumber = "+11234567890",
+                EmailVerified = true,
+                Password = "newPassword",
+                DisplayName = "Jane Doe",
+                PhotoUrl = "http://www.example.com/12345678/photo.png",
+                Disabled = true,
+            };
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine($"Successfully updated user: {userRecord.Uid}");
+            // [END update_user]
+        }
+
         internal static async Task DeleteUserAsync(string uid)
         {
             // [START delete_user]
@@ -93,6 +147,33 @@ internal static async Task DeleteUserAsync(string uid)
             // [END delete_user]
         }
 
+        internal static async Task ListAllUsersAsync()
+        {
+            // [START list_all_users]
+            // Start listing users from the beginning, 1000 at a time.
+            var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
+            var responses = pagedEnumerable.AsRawResponses().GetEnumerator();
+            while (await responses.MoveNext())
+            {
+                ExportedUserRecords response = responses.Current;
+                foreach (ExportedUserRecord user in response.Users)
+                {
+                    Console.WriteLine($"User: {user.Uid}");
+                }
+            }
+
+            // Iterate through all users. This will still retrieve users in batches,
+            // buffering no more than 1000 users in memory at a time.
+            var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetEnumerator();
+            while (await enumerator.MoveNext())
+            {
+                ExportedUserRecord user = enumerator.Current;
+                Console.WriteLine($"User: {user.Uid}");
+            }
+
+            // [END list_all_users]
+        }
+
         internal static async Task SetCustomUserClaimsAsync(string uid)
         {
             // [START set_custom_user_claims]
@@ -127,5 +208,42 @@ internal static async Task SetCustomUserClaimsAsync(string uid)
             Console.WriteLine(user.CustomClaims["admin"]);
             // [END read_custom_user_claims]
         }
+
+        internal static async Task SetCustomUserClaimsScriptAsync()
+        {
+            // [START set_custom_user_claims_script]
+            UserRecord user = await FirebaseAuth.DefaultInstance
+                .GetUserByEmailAsync("[email protected]");
+            // Confirm user is verified.
+            if (user.EmailVerified)
+            {
+                var claims = new Dictionary<string, object>()
+                {
+                    { "admin", true },
+                };
+                await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
+            }
+
+            // [END set_custom_user_claims_script]
+        }
+
+        internal static async Task SetCustomUserClaimsIncrementalAsync()
+        {
+            // [START set_custom_user_claims_incremental]
+            UserRecord user = await FirebaseAuth.DefaultInstance
+                .GetUserByEmailAsync("[email protected]");
+            // Add incremental custom claims without overwriting the existing claims.
+            object isAdmin;
+            if (user.CustomClaims.TryGetValue("admin", out isAdmin) && (bool)isAdmin)
+            {
+                var claims = new Dictionary<string, object>(user.CustomClaims);
+                // Add level.
+                claims["level"] = 10;
+                // Add custom claims for additional privileges.
+                await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
+            }
+
+            // [END set_custom_user_claims_incremental]
+        }
     }
 }

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -264,12 +264,12 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(
         /// <summary>
         /// Creates a new user account with the attributes contained in the specified <see cref="UserRecordArgs"/>.
         /// </summary>
-        /// <param name="args">Attributes that will be added to the new user account.</param>
+        /// <param name="args">Attributes to add to the new user account.</param>
         /// <returns>A task that completes with a <see cref="UserRecord"/> representing
         /// the newly created user account.</returns>
         /// <exception cref="ArgumentNullException">If <paramref name="args"/> is null.</exception>
         /// <exception cref="ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
-        /// <exception cref="FirebaseException">If an error occurs while creating rhe user account.</exception>
+        /// <exception cref="FirebaseException">If an error occurs while creating the user account.</exception>
         public async Task<UserRecord> CreateUserAsync(UserRecordArgs args)
         {
             return await this.CreateUserAsync(args, default(CancellationToken))
@@ -279,14 +279,14 @@ public async Task<UserRecord> CreateUserAsync(UserRecordArgs args)
         /// <summary>
         /// Creates a new user account with the attributes contained in the specified <see cref="UserRecordArgs"/>.
         /// </summary>
-        /// <param name="args">Attributes that will be added to the new user account.</param>
+        /// <param name="args">Attributes to add to the new user account.</param>
         /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
         /// operation.</param>
         /// <returns>A task that completes with a <see cref="UserRecord"/> representing
         /// the newly created user account.</returns>
         /// <exception cref="ArgumentNullException">If <paramref name="args"/> is null.</exception>
         /// <exception cref="ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
-        /// <exception cref="FirebaseException">If an error occurs while creating rhe user account.</exception>
+        /// <exception cref="FirebaseException">If an error occurs while creating the user account.</exception>
         public async Task<UserRecord> CreateUserAsync(
             UserRecordArgs args, CancellationToken cancellationToken)
         {
@@ -405,7 +405,7 @@ public async Task<UserRecord> GetUserByPhoneNumberAsync(
         /// Updates an existing user account with the attributes contained in the specified <see cref="UserRecordArgs"/>.
         /// The <see cref="UserRecordArgs.Uid"/> property must be specified.
         /// </summary>
-        /// <param name="args">Attributes that will be updated.</param>
+        /// <param name="args">The attributes to update.</param>
         /// <returns>A task that completes with a <see cref="UserRecord"/> representing
         /// the updated user account.</returns>
         /// <exception cref="ArgumentNullException">If <paramref name="args"/> is null.</exception>
@@ -421,7 +421,7 @@ public async Task<UserRecord> UpdateUserAsync(UserRecordArgs args)
         /// Updates an existing user account with the attributes contained in the specified <see cref="UserRecordArgs"/>.
         /// The <see cref="UserRecordArgs.Uid"/> property must be specified.
         /// </summary>
-        /// <param name="args">Attributes that will be updated.</param>
+        /// <param name="args">The attributes to update.</param>
         /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
         /// operation.</param>
         /// <returns>A task that completes with a <see cref="UserRecord"/> representing
@@ -527,7 +527,8 @@ public async Task SetCustomUserClaimsAsync(
         /// page. See <a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
         /// Page Streaming</a> for more details on how to use this API.
         /// </summary>
-        /// <param name="options">The options to control the starting point and page size.</param>
+        /// <param name="options">The options to control the starting point and page size. Pass null
+        /// to list from the beginning with default settings.</param>
         /// <returns>A <see cref="PagedAsyncEnumerable{ExportedUserRecords, ExportedUserRecord}"/> instance.</returns>
         public PagedAsyncEnumerable<ExportedUserRecords, ExportedUserRecord> ListUsersAsync(
             ListUsersOptions options)