JUjumpcloud
G Suite

List all the G Suite Translation Rules

This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to G Suite Admin SDK attributes.

Sample Request
curl -X GET  https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/gsuites/{gsuite_id}/translationrules

Request

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

Response

builtIn'user_home_addresses' | 'user_work_addresses' | 'user_other_addresses' | 'user_home_phone_numbers' | 'user_mobile_phone_numbers' | 'user_other_phone_numbers' | 'user_work_phone_numbers' | 'user_work_fax_phone_numbers' | 'user_work_mobile_phone_numbers' | 'user_manager' | 'user_alternate_email' | 'user_primary_organization_cost_center' | 'user_primary_organization_department' | 'user_primary_organization_description' | 'user_primary_organization_employee_id' | 'user_primary_organization_title' | 'user_status' | 'user_password'

Built-in translations for G Suite export:

  • user_home_addresses - Translate all JumpCloud user addresses of type home to G Suite Directory user addresses of type home
  • user_work_addresses - Translate all JumpCloud user addresses of type work to G Suite Directory user addresses of type work
  • user_other_addresses - Translate all JumpCloud user addresses of type other to G Suite Directory user addresses of type other
  • user_home_phone_numbers - Translate all JumpCloud user phoneNumbers of type home to G Suite Directory user phones of type home
  • user_mobile_phone_numbers - Translate all JumpCloud user phoneNumbers of type mobile to G Suite Directory user phones of type mobile
  • user_other_phone_numbers - Translate all JumpCloud user phoneNumbers of type other to G Suite Directory user phones of type other
  • user_work_phone_numbers - Translate all JumpCloud user phoneNumbers of type work to G Suite Directory user phones of type work
  • user_work_fax_phone_numbers - Translate all JumpCloud user phoneNumbers of type work_fax to G Suite Directory user phones of type work_fax
  • user_work_mobile_phone_numbers - Translate all JumpCloud user phoneNumbers of type work_mobile to G Suite Directory user phones of type work_mobile
  • user_manager - Translate JumpCloud user manager to G Suite Directory user relations-manager
  • user_primary_organization_cost_center - Translate JumpCloud user costCenter to G Suite Directory user costCenter for primary organization
  • user_primary_organization_department - Translate JumpCloud user department to G Suite Directory user department for primary organization
  • user_primary_organization_description - Translate JumpCloud user employeeType to G Suite Directory user description for primary organization
  • user_primary_organization_employee_id - Translate JumpCloud user employeeIdentifier to G Suite Directory user externalIds element of type organization
  • user_primary_organization_title - Translate JumpCloud user jobTitle to G Suite Directory user title for primary organization
  • user_alternate_email - Translate JumpCloud user alternateEmail to G Suite Directory user emails
  • user_status - Translate JumpCloud user status to G Suite Directory user status
  • user_password - Translate JumpCloud user password to G Suite Directory user password
direction'export' | 'import'

Direction identify if an attribute is going to be exported or imported from GSuite

  • Import- The data will be imported from GSuite into the user modal
  • Export- The data will be exported from the user modal to GSuite
idstring

ObjectId uniquely identifying a Translation Rule.

Changes

No recorded changes to this operation across all 1 revision of this API.