The driver exposes attributes that either do not map directly to eDirectory attributes or have special handling in the driver.
ExternalId is a structured, multi-valued attribute which the driver maps to the UserExternalId object in the Google Directory API. An ExternalId references an identifier outside the Google domain. An ExternalId is made up of an ID type and a value.
Valid types are:
account
custom
customer
network
organization
ExternalId is sent to the driver as a structured 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>
If the type is custom then a 3rd component with name=customtype containing the name of the custom type must be provided.
The address value displayed in the Google Admin U/I is actually the Formatted field of a UserAddress object. The U/I will show a UserAddress object of type=work and type=home, as well as custom types.
The driver generates a value for the Formatted field when it detects a change to one of the fields of a UserAddress object. The generated value is simply a concatenation, without delimiters, of the fields present on a UserAddress object. We recognize that this format may not meet every organization's needs. So we have also added WorkFormattedAddress and HomeFormattedAddress in the driver's schema. This allows an organization to directly map an attribute to update WorkFormattedAddress or HomeFormattedAddress with an address formatted to meet their needs.
Several attributes are exposed for the Google Schema that update a users default email settings within a Google Domain. These attributes are not mapped to an eDirectory attribute but can be sent on modify or add events. These attributes are:
GmailSettingsEnableIMAP
GmailSettingsEnablePop
GmailSettingsForwarding
GmailSettingsLabel
GmailSettingsEnableLanguage
GmailSettingsSendAs
GmailSettingsSignature
Table A-7 Special Attributes
Setting |
Example |
---|---|
GmailSettingsEnableIMAP Turns on or off IMAP for the Account. Set to True or False. |
<add-attr attr-name="GmailSettingsEnableIMAP"> <value type="string">true</value> </add-attr> |
GmailSettingsEnablePOP Turns on or off POP for the Account. |
<add-attr attr-name="GmailSettingsEnablePOP"> <value type=”structured”> <component name="EnableFor">Don DaRe</component> <component name="Action">don@idmtest.org</component> <component name="Enable">true</component> </value> </add-attr> |
GmailSettingsForwarding Sets a forwarding email address. Note the API only allows setting this to an account inside of the Google Apps Domain. External addresses will cause an error. |
<add-attr attr-name="GmailSettingsForwarding"> <value type=”structured”> <component name="ForwardAddress">Don DaRe</component> <component name="Action">don@idmtest.org</component> <component name="Enable">true</component> </value> </add-attr> |
GmailSettingsLabel This is a set of labels that will be automatically set on the account. The labels will be available in gmail to the end user. . |
<add-attr attr-name="GmailSettingsLabel"> <value type=”string”MyProject</value> </add-attr> |
GmailSettingsLanguage This sets the default language for the user. |
<add-attr attr-name="GmailSettingsLanguage"> <value type=”string”Eng</value> </add-attr> |
GmailSettingsSendAs Set this structured value to setup a send as alias. Useful when there are multiple domains or subdomains in Google Apps.. |
<add-attr attr-name="GmailSettingsSendAs"> <value type=”structured”> <component name="Name">Don DaRe</component> <component name=”SendAs”>don@idmtest.org</component> <component name=”ReplyTo”>Don@idmtest.org</component> <component name=”IsDefault”>true</component> </value> </add-attr> |
GmailSettingsSignature Set a default email signature on the user. This is at the user level and can be overridden by the end user. |
<add-attr attr-name="GmailSettingsSignature"> <value type=”string”>Signature Data</value> </add-attr> |