Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual
Page 60
58
Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5
Description
The ModifyUsers operation modifies a block of users and their associated
information, returning detailed status and information for each user. Failures are
reported as part of the response data structure, rather than as exceptions.
Input is a list of UserRecordPatches called Modifications.
The ModifyUser request contains:
•
AuthElem -- This required struct sets the authorization credentials for each
request. See “Authorization” on page 43. This is required.
Type: struct
•
Modifications -- An unlimited list of user information. Information for each
user is held in a UserRecordPatch. This is required.
A UserRecordPatch contains:
•
Address -- The fully qualified primary user address that is to be
modified. This is required.
Type: string.
•
NewAddress -- A new primary address of the user. This is optional.
Type: string.
•
NewOrg -- A new org for the user if the user is moved. This is optional.
Type: string
This Message Securityservice organization must already exist before
this request is called. The ModifyUser operation does not create a new
organization. This can be done using the AutomatedBatch addorg
operation. See “About the Service Management API” on page 35 for
more information about the AutomatedBatch service. For specifics
about the addorg operation, see
•
AddAliases -- An unlimited list of user alias addresses to be added.
This is optional.
Type: AddressList. This AddressList has an unlimited number of alias
Address elements.
•
DeleteAliases -- An unlimited list of user alias addresses to be deleted.
This is optional.
Type: AddressList. This AddressList has an unlimited number of alias
Address elements.
•
AddApprovedSenderAddresses -- An unlimited list of approved sender
addresses. This is optional.
Type: AddressList. This AddressList has an unlimited number of
approved sender Address elements.