Google Apps Security and Compliance Services Web Services Manual de usuario

Google Apps Security and Compliance ServicesGoogle Web Services Application Programming Interface Guide, Early Access Version 1.5• Google Message Filt

Chapter 2Introduction to Google Web Services API 7Introduction to Google Web Services APIChapter 2Welcome to the Google Web Services APIThe Google Web

8 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.5API Infrastructure -- Common features across the web se

Introduction to Google Web Services API 9When your application makes a web service request for data to the Google Web Services API, the server authent

10 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.5The Extensible Markup Language (XML) is a markup or ta

Introduction to Google Web Services API 11System InformationThe Google Web Services API, Early Access version uses these protocols and languages:• Web

12 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.5Examples of systems are:• For System 5, https://api-s5

Introduction to Google Web Services API 13These are introductory classes showing how to create a web service and client, modify an attribute, deploy t

14 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.5The development steps are:• Reference the WSDLs -- Con

Introduction to Google Web Services API 15special attention to organization, user, domain, alias concepts and functionality. For more information, see

16 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.5This example uses the WindowsFormsApplicationExample p

2 Google Web Services Application Programming Interface Guide Google, Inc.1600 Ampitheatre ParkwayMountain View, CA 94043www.google.comPart number: E

Introduction to Google Web Services API 17This example uses the AutomatedBatchService as the Web reference.12. The web reference is displayed in the s

18 Message Security and Filtering Application Programming Interface Guide RELEASE EA version 1.513. Select the web reference and click Show All Files

Chapter 3API Infrastructure 19API InfrastructureChapter 3About the API InfrastructureThis chapter presents the common web service infrastructure featu

20 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5MalformedKeyException -- This exception is thrown if

API Infrastructure 21Note: Operation-level exceptions are the most common exceptions. Handle these exceptions when the operation is called, and not at

22 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5Recommended Solution -- Stop the application. This is

API Infrastructure 23Endpoint Resolver ExceptionUnknownEmailException -- Specified email cannot be located in our system.Service Management API’s Auto

Chapter 4Endpoint Resolver 25Endpoint ResolverChapter 4About the Endpoint ResolverThe Endpoint Resolver dynamically returns the location of a web serv

26 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5For example, when updating the support contact for ms

Endpoint Resolver 27Understanding the Endpoint Resolver ServiceThe Endpoint Resolver web service has one operation, and responds either with an endpoi

3Although their code does not appear in gd 1.8.4, the authors wish to thank David Koblas, David Rowley, and Hutchison Avenue Software Corporation fo

28 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5See Also“AutomatedBatch Reference Basics” on page 36,

Endpoint Resolver 29C# ExampleThis v.1.5 C# example is using the PMP password (pword) for authentication. The snippet example was created using Micros

30 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5//Display the web service output MessageBox.Show(&

Endpoint Resolver 31Axis ExampleThis v.1.5 Java example is using Apache Axis 1.4. This example shows how to create a communication endpoint before cre

32 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5//Get the child records.qpOrgArgs.setChildorgs("

Endpoint Resolver 33JAX WS ExampleThis v.1.5 Java example was created using JAX.WS 2.0.try { // Load and instantiate an instance of our endpoint re

34 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5•automatedBatchPort = service.getAutomatedBatchPort()

Chapter 5Service Management API 35Service Management APIChapter 5About the Service Management APIThe Service Management API expands the automated capa

36 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5Understanding the Service Management APIThe Service M

Service Management API 37WSDL• WSDL: https://api-s<your system>.postini.com/dl/api/automatedbatch.wsdl• PSTN_URI: http://postini.com/PSTN/SOAPAP

4 Google Web Services Application Programming Interface Guide Google Compliance Policies Notice:Google assumes no responsibility in connection with t

38 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5 Exceptions Service Management API AutomatedBatch Exc

Chapter 6User Sync API 39User Sync APIChapter 6About the User Sync APIThe User Sync API provides bulk user management for your Message Securityservice

40 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5Compare user information -- After your application ha

User Sync API 41User Sync API ReferenceService NameUser Sync API

42 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5SummaryThe User Sync API provides the ability to retr

User Sync API 43This chapter has several code examples showing how to use the User Sync API service. It is important to remember these are simple exam

44 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5ExceptionsWhen handling exceptions, use the exception

User Sync API 45User Sync API test Operation Enumerated Types for AddStatus, ModifyStatus, and DeleteStatusWith an operation’s response, a status is g

46 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5User Sync API checkauth OperationDescriptionThe test

User Sync API 47User Sync API GetUsers OperationResponseIf successful, no data is returned except for an empty SOAP response (void). Otherwise see “Ex

Contents 1ContentsChapter 1: What’s New in This Book 3What’s New in Google Apps Security and Compliance Google Web Services API (EA v.1.5) 3Related

48 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5DescriptionReturns a list of users, with their specif

User Sync API 49• Control -- Determines the amount of detailed information returned for each user. This is required.Type: GetUsersControl.A GetUsersCo

50 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5ResponsesReturns GetUsersResponse composed of an unli

User Sync API 51 Exceptions GetUsers ExceptionInvalidCriteriaException - The search criteria could not possibly return any results, or conflicting sea

52 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5User Sync API AddUsers OperationOperationAddUsersRequ

User Sync API 53DescriptionThe AddUsers operation adds one or more users with specific information for each user held in a NewUserRecord. For more inf

54 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5• BlockedSenderAddresses -- An unlimited list of bloc

User Sync API 55• Status -- The success or failure value representing the status of adding the alias. This is required. Type: AddStatus. For more info

56 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5In the response, each blocked sender address has info

User Sync API 57User Sync API ModifyUsers OperationJAX WS 2.0 ExampleJAX-WS 2.0 Example// AuthElemAuthElem authElem = new AuthElem();authElem.setApiKe

2 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5 Chapter 5: Service Management API 35About the Servic

58 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5DescriptionThe ModifyUsers operation modifies a block

User Sync API 59• DeleteApprovedSenderAddresses -- An unlimited list of approved sender addresses to be deleted. This is optional.Type: AddressList. T

60 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5ResponsesFor each ModifyUsers request, the service re

User Sync API 61• NewAddressMessage -- The User Sync API may return human readable messages to help when debugging your application. These messages do

62 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5• AddApprovedSenderAddressStatus -- An unlimited list

User Sync API 63• AddBlockedSenderAddressStatus -- An unlimited list of structures to represent the status for requests to block sender addresses.Type

64 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5• DeleteAttributeStatus -- An unlimited list of struc

User Sync API 65User Sync API DeleteUsers OperationModifyUsers v.15, JAX WS 2.0 ExampleThis v.1.5 JAX-WS 2.0 example is using the PMP password (pword)

66 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5ResponsesResponse is a DeleteUsersResponse which hold

Index 67IndexAAddUsers operation (User Sync) 52API GuideAudience 7API InfrastructureAPI license key 19Exception management 20API license key 19excep

Chapter 1What’s New in This Book 3What’s New in This BookChapter 1What’s New in Google Apps Security and Compliance Google Web Services API (EA v.1.5)

68 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5 PProtocolsHTTPS 8IDNA (International Domain Names)

4 Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5The Message Securityservice Customer Care does not pro

What’s New in This Book 5Early Access ProgramIt is important to remember this guide supports the Google Web Services API Early Access Program. Google