Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual
Page 44
42
Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5
Summary
The User Sync API provides the ability to retrieve, add, modify, and delete an
unlimited number of users.
The User Sync API operations are:
•
User Sync API test Operation -- The test operation runs a connection level
test between the User Sync API web service and the web service client.
•
User Sync API checkauth Operation -- Verifies the specified authentication
credentials without the need to call another operation
•
User Sync API GetUsers Operation -- Returns a list of users, with their
specified information, within the list of organizations matched by the criteria
requested by the your application.
•
User Sync API AddUsers Operation -- Adds one or more users with specific
information for each user.
•
User Sync API ModifyUsers Operation -- modifies a block of users and their
associated information, returning detailed status and information for each
user.
•
User Sync API DeleteUsers Operation -- Deletes an unlimited list of users
(specified by address), and all associated user information.
The synchronized information for each user includes:
•
Address -- The primary user address, for example [email protected].
•
Org -- The user’s current Message Securityservice organization.
•
User Aliases -- List of user aliases.
•
UserAttribute -- User API Attribute is a struct containing arbitrary name/
value pairs associated with a user, and are created by the client application.
These attributes are visible only to User Sync API implementations, and are
optional elements.
•
Name -- The name of the attribute. This is a string and is required.
•
Value -- The value associated with the attribute’s name.
Note:
Attribute names must be unique, and are allowed up to 32 characters
in length. Attribute values are allowed up to 64 characters in length.
Using these attributes, client applications store and retrieve specific
implementation information for each user. Usually, these attributes hold
primary keys such as LDAP or active directory keys. The attributes are
stored with the Message Securityservice allowing synchronization no
matter if the user’s primary email address changes in the local directory.
•
Approved Sender Addresses -- List of approved senders for this user.
•
Blocked Sender Addresses -- List of blocked senders for each user.
Note:
The User Sync API elements have the same dependencies found in the
AutomatedBatch service. See for more information about the address, orgname, approved
senders and blocked senders fields.