.NET quickstart

Complete the steps described in the rest of this page to create a simple .NET console application that makes requests to the Admin SDK API.

Prerequisites

To run this quickstart, you need the following prerequisites:

  • Authorization credentials for a desktop application. To learn how to create credentials for a desktop application, refer to Create credentials.

  • A Google Workspace domain with API access enabled.
  • A Google account in that domain with administrator privileges.

Step 1: Prepare the project

  1. Create a new Visual C# Console Application project in Visual Studio.
  2. Open the NuGet Package Manager Console, select the package source nuget.org, and run the following command:
Install-Package Google.Apis.Admin.Directory.directory_v1

Step 2: Set up the sample

  1. Drag credentials.json, downloaded as a prerequisite, into your Visual Studio Solution Explorer.
  2. Select credentials.json, and then go to the Properties window and set the Copy to Output Directory field to Copy always.
  3. Replace the contents of Program.cs with the following code:

adminSDK/directory/AdminSDKDirectoryQuickstart/AdminSDKDirectoryQuickstart.cs
using Google.Apis.Auth.OAuth2;
using Google.Apis.Admin.Directory.directory_v1;
using Google.Apis.Admin.Directory.directory_v1.Data;
using Google.Apis.Services;
using Google.Apis.Util.Store;
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;

namespace AdminSDKDirectoryQuickstart
{
    // Class to demonstrate the use of Directory users list API
	class Program
    {
        /* Global instance of the scopes required by this quickstart.
         If modifying these scopes, delete your previously saved token.json/ folder. */
        static string[] Scopes = { DirectoryService.Scope.AdminDirectoryUserReadonly };
        static string ApplicationName = "Directory API .NET Quickstart";

        static void Main(string[] args)
        {
            try
            {
                UserCredential credential;
                // Load client secrets.
                using (var stream =
                       new FileStream("credentials.json", FileMode.Open, FileAccess.Read))
                {
                    /* The file token.json stores the user's access and refresh tokens, and is created
                     automatically when the authorization flow completes for the first time. */
                    string credPath = "token.json";
                    credential = GoogleWebAuthorizationBroker.AuthorizeAsync(
                        GoogleClientSecrets.FromStream(stream).Secrets,
                        Scopes,
                        "user",
                        CancellationToken.None,
                        new FileDataStore(credPath, true)).Result;
                    Console.WriteLine("Credential file saved to: " + credPath);
                }

                // Create Directory API service.
                var service = new DirectoryService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = ApplicationName
                });

                // Define parameters of request.
                UsersResource.ListRequest request = service.Users.List();
                request.Customer = "my_customer";
                request.MaxResults = 10;
                request.OrderBy = UsersResource.ListRequest.OrderByEnum.Email;

                // List users.
                IList<User> users = request.Execute().UsersValue;
                Console.WriteLine("Users:");
                if (users == null || users.Count == 0)
                {
                    Console.WriteLine("No users found.");
                    return;
                }
                foreach (var userItem in users)
                {
                    Console.WriteLine("{0} ({1})", userItem.PrimaryEmail,
                        userItem.Name.FullName);
                }
            }
            catch (FileNotFoundException e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

Step 3: Run the sample

Build and run the sample by clicking Start in the Visual Studio toolbar.

The first time you run the sample, it prompts you to authorize access:

  1. The sample attempts to open a new window or tab in your default browser. If this fails, copy the URL from the console and manually open it in your browser.

    If you're not already signed in to your Google account, you're prompted to sign in. If you're signed in to multiple Google accounts, you're asked to select one account to use for authorization.

  2. Click the Accept button.
  3. The sample proceeds automatically, and you may close the window/tab.

Notes

  • Authorization information is stored on the file system, so subsequent executions won't prompt for authorization.
  • The authorization flow in this example is designed for a command-line application. For information on how to perform authorization in a web application, see the web applications section of the library's OAuth 2.0 guide.

Troubleshooting

This section describes some common issues that you may encounter while attempting to run this quickstart and suggests possible solutions.

Could not load file or assembly 'Microsoft.Threading.Tasks'

This error can occur when using an outdated or incorrectly installed version of the Microsoft.Bcl.Async package. Reinstall the package using the following command in the NuGet Package Manager Console:

Update-Package Microsoft.Bcl.Async -reinstall

You are prompted to restart Visual Studio to complete the installation.

This app isn't verified

If the OAuth consent screen displays the warning "This app isn't verified," your app is requesting scopes that provide access to sensitive user data. If your application uses sensitive scopes, your your app must go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).

File not found error for credentials.json

When running the sample, you might receive a file not found or no such file error regarding credentials.json.

This error occurs when you have not authorized the desktop application credentials as detailed in the Prerequisites section above. To learn how to create credentials for a desktop application, go to Create credentials.

Once you create the credentials, make sure the downloaded JSON file is saved as credentials.json. Then move the file to your working directory with the rest of the sample quickstart code.

Further reading