VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
110 VMware, Inc.
<CatalogItems>
<CatalogItem name="Ubuntu Template with vsftpd"
type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalogItem/221">
<Description>Approved template for public FTP sites</Description>
<Entity href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-111"/>
<Property key="Owner">Tech Ops</Property>
</CatalogItem>
</CatalogItems>
</Catalog>
Remove a Catalog
AnadministratorcanremoveacatalogbymakingaDELETErequesttothecatalog’srel="remove"URL.
Example 6‐23removesthecatalogcreatedinExample 6‐19.
Example 6-23. Remove a Catalog
Request:
DELETE http://vcloud.example.com/api/v1.0/admin/catalog/32
Response:
204 No Content
User Administration
UserscanbecreatedinanorganizationorimportedintotheorganizationfromanLDAPdirectoryservice.
Create or Import a User
Everyuserexistswithinthecontextofanorganization.Anadministratorcanaddausertoanorganizationby
POSTingaUserbodytotheorganization’saddURLforusers,asshowninExample 6‐24,whichaddstheuser
totheorganizationcreatedinExample 6‐3.Theresponseisa
Userelement,mostofwhichisnotshowninthe
example.Theelementincludesalinkthatanadministratorcanusetoedittheuser,andadditionalelements,
suchasIsDefaultCachedandStoredVmQuota,inheritedfromorganizationdefaults.
Example 6-24. Create a User
Request:
POST http://vcloud.example.com/api/v1.0/admin/org/26/users
Content-Type: application/vnd.vmware.admin.user+xml
<User name="ExampleUser" xmlns="http://www.vmware.com/vcloud/v1">
<FullName>Example User Full Name</FullName>
<EmailAddress>user@example.com</EmailAddress>
<IsEnabled>true</IsEnabled>
<Role type="application/vnd.vmware.admin.role+xml"
href="http://vcloud.example.com/api/v1.0/admin/role/105"/>
<Password>Pa55w0rd</Password>
</User>
NOTEModifyingcatalogmetadatadoesnotaffectCatalogItemelements.Youcannotcreateacatalogthat
hasCatalogItemelementsinit.Theymustbeaddedinaseparateoperation.Forinformationaboutadding
andremovingtheseelements,see“CatalogingvAppTemplatesandMediaImages”onpage 54.

VMware VCLOUD API 1.0 - API Specifications

General

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