Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 - Manual (Page 42)

40 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5
Compare user information -- After your application has determined which users
you need to synchronize, use the GetUsers operation to retrieve those user’s
records from the Message Securityservice. Compare this information with your
user data:
• GetUsers -- Requests a list of user records with specific information. This
operation always returns status, and, if successful, it returns the list of users
and your requested information. Once the service’s user records are
retrieved, your application manages the comparison with the client-side user
information, your company’s user records. The User Sync API has no
knowledge of how your company data is stored or accessed by your
application (LDAP, Active Directory, etc.). All of these details are managed by
your application.
• A feature of User Sync API is the API User Attribute which holds
implementation specific data for a user such as information for LDAP or active
directory primary keys. These attributes are name-value pairs defined by your
application, and are applicable only with the User Sync API. These attributes
are stored with the Message Securityservice’s user record, and can be
retrieved, created, modified, and deleted along with other user
synchronization information. For more information, see the User Sync API
“Summary” on page 42.
Update the Message Securityservice’s user information -- Once your
application has determined the differences between the Message
Securityservice’s user information and your company’s user information, the
application can update the Message Securityservice’s user records:
• AddUsers -- Adds users including specific information for each user. The
information can include notifications, aliases, user attributes, and sender lists.
It always returns status, and, if successful, it returns additional information for
each new user.
• ModifyUsers -- Modifies user records such as new addresses, moving a user,
managing aliases, managing sender lists and user specific attributes. This
operation always returns status, and, if successful, it returns, for each user,
status of the associated information.
• DeleteUsers -- Deletes users and all associated information. This operation
always returns status, and, if successful, it returns a list of the deleted users.