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

Chapter 6
User Sync API 39
User Sync API
Chapter 6
About the User Sync API
The User Sync API provides bulk user management for your Message
Securityservice account. The API is optimized to efficiently retrieve, add, modify,
and delete a large number of users. In comparison, the Service Management API,
while having similar functionality, primarily provides detailed user management
functions for a single user record. For more information about the Service
Management API, see “About the Service Management API” on page 35.
Your application can use all of the Google Web Services APIs. The User Sync API
can be included in an application using the Service Management API and the
Endpoint Resolver API.
Understanding the User Sync API
Using the User Sync API, your application confirms your connectivity and
authentication. It retrieves the Message Securityservice user records. This allows
your application to compare your company’s user information to the service’s
version. Once the differences are identified, your application pushes updates to
the Message Securityservice’s user records.
Test connections and authentication -- Use the testing operations as you
develop your application and in your implementation. It is important that
connectivity and authentication credentials are validated every time your
application launches:
• test -- Runs a connection level test and exception validation between the User
Sync API web service and your application. The response is a confirmation
message.
• checkauth -- Verifies the specified authentication credentials without the need
to call another operation. The request is either successful or an exception is
returned. A log in screen is an example of how to use the checkauth
operation.