Skip to main content

IMPORTANT - Product End of Life Statement - IMPORTANT

Request RE, Survey, and Calendar 1.5 Support Ending December 31, 2020
Contact Kinetic Data Support with Questions
Kinetic Community

Google Apps SA Group Add Users

  1. Last updated
  2. Save as PDF
  1. Overview
  2. Downloads
  3. Detailed Description
  4. Parameters
  5. Sample Configuration
  6. Results
  7. Change Log

Overview

This handler adds a list of existing users to the specified group using a service account.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

google_apps_sa_group_add_users_v1.zip

This handler requires that you are running at least Kinetic Task 4.0.

Detailed Description

This handler uses the Google Admin SDK API library to add new members to a previously created Google Group. Using a Service Account Email and the corresponding P12 file (see below for details about obtaining these values) to authenticate the handler against Google's API. A string of emails are taken from the input and the handler adds these accounts to the group. Any errors that occur during the posting process will be caught and re-raised by this handler.
 
* In order to use this handler, the account specified by the task info values needs to enable Admin SDK API in admin account, set up the Service Account, and enable Domain-Wide Delegation so that the handler can impersonate an account.
 

To enable the Admin SDK and get the Service Account Email and P12 File
    1. Navigate to the 'Google Developers Console'
    2. Click on the Create Project button (or if you have an existing project that you wish to keep using, click on the project name.)
    3. Go to the APIs page and turn on the Admin SDK service
    4. Go to the Credentials page and Create a new Client Id
        * Select 'Service Account'
        * Select 'P12 Key' for Key type
    5. When you click 'Create Client Id', a P12 File will be downloaded
    6. Remember the Email for the Service Account that you just created

  To add the P12 file to the handler:
    1. Download the .zip file for the handler
    2. Expand the zipped directory, and place the P12 File that you just
       downloaded into the resources folder
        * Found at google_apps_sa_group_add_users_v1 => handler => resources
        * Remember the name of the P12 File, it will be needed later
    3. Zip the directory back up and upload to Kinetic Task

  The Service Account Email and P12 File name will be used as info values for 
  the handler, and will be used to get access to the Google Services

How to Perform Domain-Wide Delegation of Authority to Allow Impersonation
  1. Go to your Google Apps domain’s Admin console.
  2. Select Security from the list of controls. If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls.
  3. Select Advanced settings from the list of options.
  4. Select Manage third party OAuth Client access in the Authentication section.
  5. In the Client name field enter the service account's Client ID.
  6. In the One or More API Scopes field enter the list of scopes that your application should be granted access to. For example if you need domain-wide access to the Google Admin SDK enter: 
     * https://www.googleapis.com/auth/admin.directory.group, https://www.googleapis.com/auth/admin.directory.user
  7. Click the Authorize button.

Parameters

Name Description
Group ID The id of the group that the specified users should be added to.  The group id of the 'test.group@acme.com' group is 'test.group'.
Users
A comma separated list of user ids or email addresses that correspond to users that should be added to the specified group.  The user id of 'john.doe@acme.com' is 'john.doe'.

Sample Configuration

Parameter Example Configuration
Group ID test.group
Users jane.user@acme.com,joe.user@acme.com

Results

This handler returns no results

Change Log

Version Date Description
1 2015-05-28 Initial Version