Skip to main content

Hello, how can we help you today?

Or select a category below
Getting Started
Videos

User details are missing in signature when synchronized from Google Workspace

  1. Exclaimer Knowledge Base
  2. Solutions
  3. User Data
Payal Arya
  • Updated

Scenario

You have configured Exclaimer and have synchronized your data from Google Workspace. You notice that some user details, such as Job Title, are missing from your signatures.

Reason

Exclaimer for Google Workspace uses Google's API to query for data for each account and requires that the field data has the primary value set to true. 


An example of the Organzations data, shown in a request format, with primary set to true. 

If this value has not been set to true, the data will not be reflected in Exclaimer. Some services, such as OKTA, do not automatically set a value for the 'Organizations' attributes.

Resolution

You must set the primary value to true for the Organization data for each affected user. This is done by using Google Workspace's Directory API: first by taking the data using a Get request, then changing the values using an Update request.  This can be done manually in Google Workspace, or you can run a Powershell script to update the values in bulk.

Select an option below to view the related instructions:

To set the value using Google's Directory API

This resolution must be repeated for each affected user.

Pre-requisites: You must have login credentials for a scoped Google Workspace account to complete this resolution.

To change the primary value for Organization data:

  1. Navigate to the Google Workspace Admin console - Directory API page for a Get request using the following link: https://developers.google.com/admin-sdk/directory/v1/reference/users/get.
     
  2. Select API from the icons panel menu to open the APIs Explorer pane. 


    Select API from the vertical panel menu.
     
  3. Under Request parameters, enter the email address of a user to query in the userKey field.
     
  4. From the projection drop-down, select full.


    An example of a completed query for a sample user. 
     
  5. Select Execute. You may need to scroll. 


    The Execute button is found after the full content of the pane.
     
  6. When prompted, sign into a scoped Google Workspace account to authenticate the query.
     
  7. From the query results, copy the full organizations parameter, including all sub-parameters.
     
  8. Navigate to the Directory API page for an Update request using the following link: https://developers.google.com/admin-sdk/directory/v1/reference/users/update
     
  9. Select API from the icons panel to open the APIs Explorer pane. 
     
  10. Enter the email address of the same user as before in the userKey field.
     
  11. In Request body, paste the parameter you copied in Step 7. 
     

  12. Enter the following text as a sub-parameter:

    "primary": "True"
     
    NOTES: If the primary value is already present, it may appear as: 
    "primary": ""

    In this case, add True inside the quotation marks. 

    Ensure that you add a comma in the appropriate place if adding this text to a list of other sub-parameters. All sub-parameters must be separated by a comma.


    An example of a completed query with the organizations data for the same user, with the primary value updated to be set to True.
     

  13. Select Execute. You may need to scroll. 
     
  14. When prompted, sign into a scoped Google Workspace-Suite account to authenticate the query, and allow the permissions request.
     
  15. Repeat this process for all affected users.
     
  16. Re-synchronize your user data in Exclaimer. 
To set the value using a Powershell script

This Powershell script sets the primary value to True for all active users.

To change the primary value for Organization data:

  1. Open Windows Powershell.
     
  2. Run the following command:

    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass; Invoke-WebRequest -Uri "https://raw.githubusercontent.com/exclaimerltd/Internal-Support-Scripts/master/GoogleAPIFieldPrimary.ps1" -OutFile "$env:TEMP\GoogleAPIFieldPrimary.ps1"; & "$env:TEMP\GoogleAPIFieldPrimary.ps1" 
     
  3. Follow the steps provided by the script.
     
  4. Re-synchronize your user data in Exclaimer. 
NOTE: For OKTA users, it is possible to add the Primary attribute for newly created users in OKTA. For more information, see a third-party guide for a solution: https://support.bettercloud.com/s/article/Okta-to-G-Suite-Provisioning-bc88101