beautypg.com

Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual

Page 55

background image

User Sync API

53

Description

The AddUsers operation adds one or more users with specific information for
each user held in a NewUserRecord. For more information on the AddUsers
detailed response status for each user, see “Responses” on page 54.

An AddUser request contains:

AuthElem -- This sets the authorization credentials for each request. See
“Authorization” on page 43. This is required.

Type: struct

NewUsers -- An unlimited list of records with each record holding
information for a new user. This is required.

Record Type: NewUserRecord

The elements for a NewUserRecord are:

Address -- A fully qualified primary user address, for example
[email protected]. This is required.

Type: string

Org -- The Message Securityservice’s organization associated with the
user. If not specified, the service puts the user into the account
organization. This is optional.

Type: string

Note:

Adding a user with a non-specified organization to the account

organization is different from the AutomatedBatch API’s adduser operation
which adds the new user to the organization associated with the user’s
domain.

SendWelcomeImmediately -- If true, new user welcome messages are
sent immediately. Otherwise, messages will be queued and sent within
24 hours. This is required.

Type: boolean

Attribute -- An unlimited list of name-value User API Attributes. For
more information about User API Attributes, see the UserSync
“Summary” on page 42. This is optional.

Type: AttributeList. An AttributeList has an unlimited number of Attribute
elements. An Attribute is of type UserAttribute.

Aliases -- An unlimited list of the user’s alias addresses. This is
optional.

Type: AddressList. An AddressList has an unlimited number of alias
Address elements.

ApprovedSenderAddresses -- An unlimited list of approved sender
addresses associated with the user. This is optional.

Type: AddressList. An AddressList has an unlimited number of
approved sender Address elements.