Access Certification21

Access Requests20

Access Risk Settings2

Active Directory9

Administrators4

Agent Groups5

Agents11

Aggregated Policy Stats1

App Catalog2

Apple MDM21

Applications8

Assets27

Authentication Policies8

Bulk Job Requests9

Commands2

Custom Emails5

Directories1

Duo9

Email Subscriptions2

FeatureTrials1

G Suite15

GCEP4

Google EMM21

Graph119

Groups1

Identity Risk10

IP Lists6

LDAP Servers3

Logos1

mdm24

Microsoft MDM1

Monitoring and Alerting19

Notifications Channels6

Object Storage2

Office 36513

Organization Feature Settings2

Organizations1

Password Manager40

Password Policy10

Password Vault69

Policies9

Policy Groups5

Policytemplates2

Privileged Access25

Providers82

Push Verification2

Reports25

Roles5

SaaS App Management13

Samba Domains5

Sample Data1

Saved Views6

Scope Groups1

Search3

Service Accounts6

Slack Notifications1

Software Apps9

Subscriptions1

System Groups7

System Insights60

Systems6

Systems Organization Settings8

Translation Rules7

User Groups7

Users4

Webhook Notifications1

Webhook Notifications Channels1

Workday Import9

Workflows10

G Suite

Create a new G Suite Translation Rule

This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to G Suite Admin SDK attributes.

Sample Request

curl -X POST 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}' \
  -d '{
    {Translation Rule Parameters}
  }'

post/gsuites/{gsuite_id}/translationrules

Request

Base URL
https://console.jumpcloud.com/api/v2
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/gsuites/:gsuite_id/translationrules/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

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

Example request

{
  "builtIn": "user_home_addresses",
  "direction": "export"
}

Response

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.