3.6 Other Attributes

Several attributes are exposed for the Google Schema that the driver can use to make settings in G Suite. The following table summarizes these attributes and provides an example of the settings.

Table 3-5 Other Google Schema Attributes

Attribute

Example DOM and Notes

CN

User Object. This attribute is mapped to Google’s UserName.

In G Suite the UserName is the user’s primary email address name unless you use the GMailSettingsSendAs attribute to change it. The default driver config uses the source name of the user object (naming value of the user) and then adds the primary G Suite email domain name (i.e. user@mycompany.com). 

In a multi-domain environment, you must set the user’s CN value to the domain in which you wish to create the user in the form of the email address (user@domainname.org). 

Permission

This attribute is set on Group objects during creation. This is a GCV setting that can be overwritten in the Create Rule.     

<add-attr attr-name="Permission">
          <value>Owner<value>
</add-attr>

Valid values are: Owner, Member, Domain, Anyone

Attribute

Example DOM and Notes

Assistant & Manager

These are not special attributes but do not have the same behavior as other drivers.    

Assistant and Manager will only synchronize a DN (\\tree\org\user\myname) value to G Suite unless a transformation is written (typically in the output transformation) that will query back for the information you want to send to G Suite. This is information that will show up on the Google Contacts. For instance, if you would like the Manager or Assistants email address you would have to write a policy that would trigger on the Assistant/Manager attribute and then query back using the DN value for the Internet Email Address and finally reformat the attribute.    

DirXMLGAGroupEMailAddress

This attribute is required on the Group object for sync to G Suite. 

<add-attr attr-name="DirXMLGAGroupEMailAddress">
          <value>GroupA@mycompany.com<value>
</add-attr>

In a multi-email domain environment (where there is a primary email domain and secondary/subdomain) it is possible through the API to have groups in the secondary/subdomain domain. For example if your G Suite Primary Email domain is mycompany.com and your secondary domain is mycompany.org you could create the group’s email address in the secondary domain by setting this value to groupa@mycompany.org

The default driver pre-config will set this value to the CN value of the object and the primary domain name. 

Note that the Google Admin interface will not allow this creation within the UI but will allow you to see the group and manage it once it is created. 

preferredName

By default, this attribute is mapped to G Suite’s Alias attribute. It is used to add a nickname to the user’s mail account.

<add-attr attr-name="preferredName">
         <value>First.Last@mycompany.com<value>
         <value>first@mycompany.com<value>
</add-attr>

The value should always be in the form of name@domain name.

Facsimile Telephone Number

Due to the way eDirectory stores this attribute it cannot be sent to Google without a transformation.

There is a policy that changes the format of this attribute so that G Suite can consume it. The policy will take the first value found and send that value while removing the structured values.

Attribute

Example DOM and Notes

AgreedToTerms

AgreedToTerms is a flag indicating that you have agreed to Google’s terms and conditions the first time you log into GA. This is a query-only attribute. You may not set this value.

The Google Provisioning API does not allow this value to be set. It can be queried to determine if the user has accepted the Google Terms on first login.

IsAdmin

This is a flag that can be set on a user object to make the user a Domain Admin.   

This attribute will return true if the user is a domain admin. The user can be made domain admin by setting it to true. Set it to false to remove that authority.

ExternalId

ExternalIds reference identifiers in external systems. An external ID contains an ID value and an ID Type. Valid types are:

  • account

  • custom

  • customer

  • network

  • organization

ExternalId is sent to the driver as a structured type. If the value of "type" is "custom" then a third component with name="customtype" must be provided to specify the custom type.

<modify-attr attr-name="ExternalId">
      <add-value>
          <value timestamp="1467727743#2" type="structured">
<component name="value">bob@dog.com</component>
<component name="type">account</component>
    </value>
      </add-value>
</modify-attr>