CreatingClientSecretsFile

Ron Jarrell edited this page Feb 24, 2017 · 106 revisions

Creating the client_secrets.json and oauth2service.json files for GAM

To use GAM, you need to create your own client_secrets.json and oauth2service.json files. These give you your own personal quota of API requests.

Steps

Enable API access for G Suite and Login.

This step requires a domain super-admin account or an account with delegated Security rights

  1. In the domain's Admin Console, go to the Security section, then click on API reference
    gam-30
  2. If API access is not already enabled: 1. click to check the box for Enable API access 1. click the Save button
  3. Login to a Google account. The account does not need to be in your G Suite domain or have any special rights.

Create a Google API Project.

  1. Go to this link to start. This link will begin the project creation process, and specifies the APIs that must be included in the project.
    gam-101 1. Verify that Create a new project is selected 1. click the Continue button 1. within a few seconds, your project will be created and the screen will display a confirmation message. On the confirmation screen, verify that all of the required APIs listed below are included. (Other APIs may also be enabled. You may ignore them.)
    Required APIs:

    • Admin SDK
    • Apps Activity API
    • Contacts API
    • Enterprise License Manager API
    • Gmail API
    • Google Calendar API
    • Google Classroom API (Google for Education domains only)
    • Google Drive API
    • Google+ API
    • Groups Settings API
  2. Click on Go to credentials.
    gam-103

Rename the project.

  1. By default, the new project will be named My Project or something similar. The project should be renamed so that you will know that it is a GAM project.
  2. Near the top right of the screen, click on the project selection menu (The menu may be labeled Go to project or may be the name of a specific project).
    gam-104
  3. A list of all active projects will be displayed. Find the line for the project just created. At the far right of that line, click on the pencil icon to re-name the project. gam-105
  4. choose a name that is meaningful to you and identifies the project as a GAM project. gam-107

Create the Credentials files

  1. Create client_secrets.json 1. Make sure you're at the API Manager 1. in the left side menu, click on Credentials 1. in the top menu, click on OAuth consent screen gam-50 1. enter a Product name. It can be the same project name that you used previously
    gam-74 1. at the bottom of the screen, click Save
  2. On the next screen, in the center of the screen, click on Create credentials and choose OAuth client ID
    gam-75
    1. on the next screen, change the Application type to Other, enter a name, and click Create.
    gam-36 1. click the Save button.
    1. in the pop-up confirmation window, click OK. You do not need to record the client ID or client secret
    2. on the next screen, you will see a section labeled OAuth 2.0 client IDs. The client you just created will be listed. The Type column will say Other. gam-52
    3. at the far right of the line, click the download button.
    4. save the file to the same folder as GAM.exe or GAM.py and rename the file to client_secrets.json.
      gam15
  3. create oauth2service.json 1. near the top left of the screen, click on the Create credentials button and select Service account key
    gam-78 1. under the label Service account, click the menu and select New service account. gam-81 1. enter a name for the service account. It can be the same name as the project. 1. select the JSON key type 1. click the Create button
    gam-82a 1. when it says your service account has no role, just click "Create without a role". 1. a file download will start automatically. Save the file to the same folder as GAM.exe or GAM.py and rename the file to oauth2service.json. Note the message that says this is your only chance to save this key. You will not ever get another opportunity to download it, and if you lose the file, you'll need to generate a new key. The "Download JSON" button this page does not download the same type of file.
    gam19 1. in the pop-up dialog, click Close
  4. There are now two sections in the screen - OAuth 2.0 client IDs and Service account keys. At the far right of the Service account keys section, click on Manage service accounts. gam-83 1. on the next screen, find the line with the name of the service account you just created. At the far right of that line, click on the 3-dots button and select Edit. gam-84 1. in the pop-up dialog, check the box to Enable G Suite Domain-wide Delegation and then click Save.
    gam-85 1. in the top left corner of the screen, click on the card-stack menu button, then click on API Manager, then click on Credentials.
    gam-89
    gam-90
    gam-91
    1. in the main part of the screen, the section labeled OAuth 2.0 client IDs now has two lines: one for the OAuth2 client (Other) and one for the Service account client. The column to the far right lists the Client ID for each client. These Client IDs will be used in the next step. gam-92

Authorize the Service Account API scopes for use with GAM in the Admin Console

  1. In this step, you will switch between the Developer's console and the domain's Admin console. To access the Admin console, you must use an account with domain super-admin account or an account with delegated Security rights. The Developer's console window must be logged in to the account in which the project was created. These can be the same account or different accounts.
  2. Authorize scopes for the service account 1. in the OAuth 2.0 Client IDs section, click and drag to select the Service Account's client ID and copy it (Control/Command-C). The client ID is a long string of numbers and/or letters (but is not the same client ID as the OAuth client ID).
    gam-60 1. in another browser window or tab, login to G Suite using a domain super-admin account
    1. go to the G Suite Admin Console
    2. click the Security icon
      gam23 1. in the Admin Console, go to the Security section, click on Show more, then Advanced settings, then Manage API client access
    3. near the top of the screen, paste the Client ID into the field labeled Client Name
    4. Select the entire list of Service Account API scopes below, copy it (Control/Command-C) and paste it into the field labeled One or More API Scopes on the Admin Console screen
    5. click the Authorize button gam26
    6. in the list of projects and scopes, the OAuth2 Client ID will appear in the left column and the list of API scopes will appear in the right column
      gam-62

Service Account API scopes

https://mail.google.com/,
https://sites.google.com/feeds,
https://www.google.com/m8/feeds,
https://www.googleapis.com/auth/activity,
https://www.googleapis.com/auth/calendar,
https://www.googleapis.com/auth/drive,
https://www.googleapis.com/auth/gmail.settings.basic,
https://www.googleapis.com/auth/gmail.settings.sharing,
https://www.googleapis.com/auth/plus.login,
https://www.googleapis.com/auth/plus.me,
https://www.googleapis.com/auth/userinfo.email,
https://www.googleapis.com/auth/userinfo.profile,

Run GAM to authorize the Client API Scopes

  1. open a command line window and navigate to the file gam.exe or gam.py
  2. If you are running on a headless system (e.g. ssh'd to a server) then create a file called nobrowser.txt (e.g. touch nobrowser.txt )
  3. run the command gam oauth create
  4. the configuration options will be displayed. Most API scopes will be selected by default. 1. There is a limit to the number of API scopes that a project can have active. If you need the services provided by one of the unselected APIs you must disable one of the other APIs (type its number and press Enter) and then selecting the required API (type its number and press Enter). 1. Choose the last option in the list (Continue): type its option number and press Enter.
    gam-95
  5. a browser window will open to display the confirmation screen.
    1. if the computer that you are running GAM on does not have a web browser, you can use a browser on another computer to complete this step. On the other computer, enter the goo.gl short URL that is displayed in the command line window
    gam22
    • if you are replacing existing client_secrets.json and oauth2service.json files, it may be necessary to remove or rename your existing oauth2.txt file for the goo.gl short URL to be displayed 1. scroll to the bottom of the list of permissions and click Allow
      gam21 1. the web page will report that the authentication flow has completed. 1. in the command line window, the GAM command will complete, and you will see information about the G Suite domain

If You Use a Proxy

If you access the web via a Proxy is may be necessary to set a Proxy in GAM, to do so:

set http_proxy=http://1.2.3.4:8080 set https_proxy=http://1.2.3.4:8080

Obviously you need to set your proxy to the correct IP address that you use. The above 1.2.3.4 and port 8080 is for example purposes. Credit for this to Craig Box

gam oauth request

GAM is now ready for use.

From time to time, Google changes one or more of the tools used in this process. Some of the steps may change, or what you see on the screen may differ from what is shown here. Please post a comment in the discussion forum if you find an outdated or incorrect instruction (or just fix it - anyone can edit the wiki).

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.