beautypg.com

Understanding the service management api, Automatedbatch reference basics – Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual

Page 38

background image

36

Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5

Understanding the Service Management API

The Service Management API service is called AutomatedBatch. The service has
25 operations ranging from managing organizations, domains, users, reports,
authorizations, and aliases to running a connection test:

When your application makes an operation request, the AutomatedBatch
service authenticates the request, validates the API license key, runs the
command, and prepares the resulting data.

AutomatedBatch then sends a response with the serialized data across the
Internet as a secure transaction to your application. The data is then
deserialized making it available to your web service application.

If your application modifies user settings across a cluster of systems, for each
user, it would call the Endpoint Resolver service to locate the user’s
AutomatedBatch web service. See “About the Endpoint Resolver” on
page 25.

AutomatedBatch Reference Basics

Service Name

AutomatedBatch

Summary

The AutomatedBatch service is composed of a key set of email security service
batch commands used to manage users, organizations, and domains.

Authorizations

The authorization element requires an API license key, an administrator’s
login ID and password. For the API license key, see “API License Key” on
page 19.

Individual read and modify authorizations are required for each command
and related field.