Sync User Attributes with Google Workspace

After you've authorized sync with Google Workspace, you can choose the user attributes you want to import or export with Google Workspace.

Prerequisites

  • You must have Google Workspace sync authorized and active on the Google Workspace directory. See Google Workspace Sync.

Attribute Data Flow

How does attribute data flow between Google Workspace and JumpCloud after integration

Data flow for synced user attributes:

  • When you import a user from Google Workspace – if data exists for a user’s attributes in Google Workspace when they are imported, data is written to the equivalent user attributes in JumpCloud.
  • Importation of these attributes must be done before the user exists in JumpCloud.
  • You MUST configure the cloud directory connector so that the attributes you want to import are set to import and disabled or export.
  • When you bind that user to Google Workspace in JumpCloud – attributes in Google Workspace are automatically overwritten with data from JumpCloud. Further, any subsequent changes made to the user’s attributes in JumpCloud are automatically pushed to the corresponding attributes in Google Workspace.

Attribute Data

Attributes

These attributes are “JumpCloud-owned”:

  • First name (always imported on new users, and exported for bound users)
  • Last name (always imported on new users, and exported for bound users)
  • Password (not imported, always exported for bound users)
  • Company email (always imported on new users, and exported for bound users)

Attributes that can optionally be exported or imported to/from Google Workspace:

  • Alternate Email
  • Manager
  • Work address
  • Work phone
  • Work fax
  • Work cell
  • Employee type
  • Department
  • Employee ID
  • Cost center
  • Title
  • Home address
  • Home phone
  • Personal cell

API Attribute Name Table

The following table outlines how attribute data is exported from JumpCloud’s API and UI to Google Workspace's API and UI. The attribute listed in the JumpCloud API Attribute Name column is synced to the attribute listed in the Google Workspace API Attribute Name column. The attribute listed in the JumpCloud UI Attribute Name column is synced to the attribute listed in the Google Workspace UI Attribute Name column. Be aware that Microsoft 365 and Entra ID use multiple UI labels for the same data. The following Microsoft 365 UI Attribute names represent what is used when an administrator adds or edits details for a user in Microsoft 365.

This table outlines how attribute data is synced from JumpCloud's API to Google Workspace's API. The attribute listed in the JumpCloud API Attribute Name column is synced to the attribute listed in the Google Workspace API Attribute Name column. 

See our API documentation: Create a new G Suite Translation Rule.

Considerations

  • Note about address attributes: Both the JumpCloud and Google Workspace APIs allow multiple addresses for a given type. On export, existing Google Workspace addresses for a given type are replaced with JumpCloud addresses of that type.
  • Make sure you have read through the considerations for Integrating Google Workspace with JumpCloud.

UI Attribute Name Table

This table outlines how attribute data is synced from JumpCloud's UI to Google Workspace's UI. The attribute listed in the JumpCloud UI Attribute Name column is synced to the attribute listed in the Google Workspace UI Attribute Name column.

Google User Attributes

JumpCloud API Attribute Name

Google Workspace API Attribute Name

JumpCloud UI Attribute Name

Google Workspace UI Attribute Name

Notes

firstname name.firstName First Name First name
lastname name.lastName Last Name Last name
password password Password Password
email primaryEmail Company Email Primary email
alternateEmail emails Alternate Email Secondary Email
jobTitle organization.title Job Title Job title
employeeIdentifier externalId.value Employee ID Employee ID
department organization.department Department Department
costCenter organization.costCenter Cost Center Cost center

addresses.type
addresses.poBox
addresses.extendedAddresses
addresses.locality
addresses.region
addresses.postalCode

addresses.formatted Work Address Address (Work)

Export: Addresses are exported as a single, formatted value that includes all of the address values listed in the JumpCloud API Attribute Name column.

Import: JumpCloud will import from Work Address into the structured address fields. The preferred address format is:

{House number} {Street name} {City} {State} {Country code}

Ex: 101 Main Street Denver Colorado 80202 US

Home Address Address (Home)

Export: Addresses are exported as a single, formatted value that includes all of the address values listed in the JumpCloud API Attribute Name column. JumpCloud will overwrite Google’s Home Address field with a concatenated string from JumpCloud’s structured address fields. 

Import: JumpCloud will import from Home Address and Work Address into the structured address fields. The preferred address format is:

{House number} {Street name} {City} {State} {Country code}

Ex: 101 Main Street Denver Colorado 80202 US

This field contains a drop-down type field.

Note about address attributes: Both the JumpCloud and Google Workspace APIs allow multiple addresses for a given type. On export, existing Google Workspace addresses for a given type are replaced with JumpCloud addresses of that type.

  • phoneNumbers.type
  • phoneNumbers.number
  • phones.type
  • phones.value
Work Fax -

Data exported for this attribute is viewable only in the Google Workspace API.

Work Cell -

Data exported for this attribute is viewable only in the Google Workspace API.

Home Phone Phone (Home)
Personal Cell Phone (Mobile)
manager realation(s) Manager Manager's Email

Google Workspace stores the Manager’s email in the relations array with a type of “manager”. Manager is a relational attribute in JumpCloud, meaning we use the unique ID of the Manager. 

Export:

  • JumpCloud will add the Manager’s email to relations.
  • JumpCloud will add the Manager’s email address to the “Manager’s email” field.

Import:

  • JumpCloud will add the Manager to the user being imported if the Manager exists in JumpCloud.

 

User Attribute Export

Note:

Custom user attributes aren't supported. 

With the exception of several attributes that are selected by default, you can choose the user attributes you would like to export to Google Workspace. Selected attributes are automatically synced with Google Workspace. This means that after you export an attribute to Google Workspace, data for that attribute is sent from JumpCloud to Google Workspace. Likewise, if you choose to stop exporting data for an attribute, it is no longer synced with Google Workspace. Subsequent changes made to that attribute in JumpCloud aren't exported to Google Workspace.

Warning:

Take caution when selecting attributes to export. After you select an attribute to export to Google Workspace, it is immediately overwritten with data from JumpCloud for all Google Workspace users managed by JumpCloud, and you could potentially lose data stored for that attribute in Google Workspace. See Attribute Data above to learn about how attribute data is exported to Google Workspace.

User Attribute Import

You can choose the user attributes that you would like to import from Google Workspace for new users. First name, Last name, and Company email will always be imported from Google Workspace. Any other attribute in the list below can be set to “Import”. These attributes will be mapped from Google Workspace to the corresponding JumpCloud attribute. See Attribute Data above to learn about how attribute data is exported to Google Workspace.

Selecting Attributes to Export or Import

  1. Log in to the JumpCloud Admin Portal.
  2. Go to DIRECTORY INTEGRATIONS > Cloud Directories.
  3. Select the Google Workspace directory you want to select user attributes for.
  4. In the Attribute mapping and settings section, select the non-default user attributes you want to import or export with Google Workspace.

Note:

You can't clear default user attributes.

  1. Click save.

After you configure user attributes to sync from JumpCloud and Google Workspace, bind JumpCloud users to Google Workspace. See Giving JumpCloud Users Access to Google Workspace.

Directory Insights Events

Anytime you change the direction of an attribute, a Directory Insights event is generated. Previously, these events were:

  • translationrule_create
  • translationrule_delete

If you see an event with these names in your Directory Insights logs, they will roll off once your maximum retention period is exhausted. Going forward, the Directory Insights events generated from attribution selections are:

  • integrationattribute_exclude
    • Generated when an attribute is set to “Exclude”.
      • Ex: You change the Department attribute from “Import” to “Exclude”
  • integrationattribute_include
    • Generated when an attribute is set to “Import” or “Export”.
      • Ex: You change the Department attribute from “Exclude” to “Import”
      • Ex: You change the Department attribute from “Import” to “Export”

These events will capture attribute ownership/direction changes, including the admin that made the change, and the directory integration in which the change occurred.

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case