VMware VCLOUD API 1.0 - API User Manual

VMware, Inc. 185
Chapter 11 Administrative API Reference
OrgEmailSettings
TheOrgEmailSettingselementdefinestheemailsettingsforanorganization.
SmtpServerSettings
IfIsDefaultSmtpServer(inOrgEmailSettings)isfalse,theSmtpServerSettingselementspecifies
connectiondetailsfortheorganization’sSMTPserver.
Users
TheUserselementisaread‐onlycontainerforReferenceTypeelementsthatreferenceusersinan
organization.Toadduserstoanorganization,see“CreateorImportaUser”onpage 110.
Groups
TheGroupselementisaread‐onlycontainerforReferenceTypeelementsthatreferencegroupsinan
organization.Toaddgroupstoanorganization,see“ImportaGroup”onpage 113.
Catalogs
TheCatalogselementisaread‐onlycontainerforReferenceTypeelementsthatreferencethecatalogsinan
organization.Toaddcatalogstoanorganization,see“CreateaCatalog”onpage 107.
Schema
Name Min Max Type Description
IsDefaultSmtpServer 1 1 xs:boolean Trueifthisorganizationusesthesystemdefault
SMTPserver
IsDefaultOrgEmail 1 1 xs:boolean Trueifthisorganizationusesthesystemdefault
emailproperties.
FromEmailAddress 1 1 xs:string IfIsDefaultOrgEmailisfalse,specifiesthe
sender’semailaddressthatappearsinemail
notifications.
DefaultSubjectPrefix 1 1 xs:string IfIsDefaultOrgEmailisfalse,specifiesaprefix
forsystememailnotifications.
IsAlertEmailToAllAdmins 1 1 xs:boolean Trueifsystememailnotificationsshouldbe
sent
toalluserswhohavetheAdministratorrole
AlertEmailTo 0 n xs:string IfIsAlertEmailToAllAdminsisfalse,specifies
alistofuserstoreceivesystememail
notifications.
SmtpServerSettings 0 1 SmtpServerSettingsType IfIsDefaultSmtpServerisFalse,thiselement
specifiesconnectiondetailsforanSMTPserver
touse.
Schema
Name Min Max Type Description
IsUseAuthentication 1 1 xs:boolean Trueifthe
SMTPserverrequiresauthentication
Host 1 1 xs:string HostnameoftheSMTPserver.
Username 1 1 xs:string UsernametousewhenloggingintotheSMTPservice.
(RequiredifIsUseAuthenticationisTrue).
Passwo rd 0 1 xs:string PasswordfortheuseridentifiedbyUsername.Thisvalue
isneverreturnedbyGET.Itisinspectedoncreateand
modify.Onmodify,theabsenceofthiselementindicates
thatthe
passwordshouldnotbechanged.Requiredif
IsUseAuthenticationistrue.

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English