7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- Working with Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
Parameter Description
Links Species an array of link objects, each of which contains the
following parts:
n
rel
Species the name of the link.
n
Self refers to the object that was returned or
requested. This parameter does not appear when
you query a single prole.
n
First, Previous, Next, and Last refer to
corresponding pages of pageable lists.
n
Species the application or service that determines
the other names.
n
href
Species the URL that produces the result.
Content Species an array of data rows, each of which represents
one of the tenant objects returned in a pageable list. Each
tenant object can contain the following information:
n
Id:
Species the unique tenant identier.
n
urlName:
Species the name of the tenant as it appears in URLs.
n
Name:
Species the name of the tenant for display purposes.
n
description:
Species the long description of the tenant.
n
contactEmail:
Species the primary contact email address.
n
Password:
Unused
n
defaultTenant:
Is set to True if the corresponding tenant is the default
tenant (vsphere.local).
Metadata Species the following paging-related data:
n
Size: Species the maximum number of rows per page.
n
totalElement: Species the number of rows returned.
This parameter is not output when you query for a
single prole.
n
totalPages: Species the total number of pages of data
available.
n
Number: Species the current page number.
n
Oset: Species the number of rows skipped.
Example: curl Command
The following example command lists the identity stores by using variables, instead of the full token and
host name.domain name.
curl --insecure -H "Accept: application/json" -H 'Content-Type: application/json'
-H "Authorization: Bearer $token” https://$host/identity/api/tenants/MYCOMPANY/directories
Programming Guide
24 VMware, Inc.