VMware Cloud Partner Navigator API Request Parameters
You can specify request parameters in your HTTP requests to the VMware Cloud Partner Navigator APIs to filter the information, or to perform a given task.
Billing API Request Parameters
You must provide the appropriate request parameters to get the required data from the Billing & Subscriptions API. To customize the returned content, you can use the optional query parameters.
| Name | Type | Description |
|---|---|---|
| orgId | Path |
Service provider or tenant organization ID for which raw data usage reports or subscriptions are fetched. |
| tenantId | Query |
If orgId is set with a service provider organization ID, the service provider can specify the tenant organization ID to filter and obtain billing results for this particular tenant. |
| startTime | Query |
Sets the starting time period of obtaining raw usage report. If the specified time is the middle of the month, it rounds to the beginning of that month. The value is in the format of UNIX epoch timestamp. |
| endTime | Query |
Sets the ending time period of obtaining raw usage report. If only startTime is provided, the end time is assumed to be the last billing period. If endTime value is set to the middle of the month, it rounds to the beginning of the month. Value is in the format of UNIX epoch timestamp. |
| serviceIds | Query |
Lists the raw usage data in a comma separated, one or more service definition IDs. |
| detailView | Query |
Defines the returned information. It can contain the most granular usage distribution of data or provide a summary view where the summation happens at the most atomic quantity. When set to true, returns a summary view. |
| providerReport | Query |
When set to true and orgId is a service provider organization, the providerReport lists the usage reports or subscriptions for the provider organization only. In this case, overrides tenantId. When set to false and tenantId is not used, the usage data for all the tenants in the master organization is fetched. |
| allTenants | Query |
When set to true, returns all subscriptions for all the tenants. Otherwise, returns the service provider subscriptions. By default, false. |
Support API Request Parameters
You must provide the appropriate request parameters to get the required data from the Support API. To customize the returned content, you can use the optional query parameters.
| Name | Type | Description |
|---|---|---|
| orgId | Path |
Service provider or tenant organization ID for which support tickets are fetched, updated, or related. |
| orgName | Query |
Organization name for which the support tickets are fetched. |
| category | Query |
Returns support tickets by an issue category. |
| severity | Query |
Returns support tickets by severity. |
| status | Query |
Returns support request by a specified status. |
| subject | Query |
Returns support tickets which contain a phrase in the subject. |
| includeTenantOrgs | Query |
Returns support requests created for the current organization and its tenant organizations. |
| internalTicketId | Query |
Returns service provider internal support ticket ID. |
| pageStart | Query |
The start point for index of records to fetch. By default, 1. |
| pageLimit | Query |
Returns the maximum number of support tickets. By default, 100. |
| supportRequestId | Path |
An ID for which a support request is found and updated. |
| userTicketsOnly | Query |
Returns support requests created by the current user only. |
| fileDetail | FormData |
Provides additional details on a support ticket in a file format. |
| uploadedInputStream | FormData |
Provides file stream. |
| tenantId | Query |
Returns the categories for a particular tenant organization. |
Tenant Organization Management API Request Parameters
You must provide the appropriate request parameters to perform the required action with the Tenant Organization Management API.
| Name | Type | Description |
|---|---|---|
| orgId | Path |
Service provider organization under which a tenant organization is managed or created. |
| tenantType | Query |
Defines the tenant type. Either
|
| country | Query |
Standard two-letter country code (for example US, CA, IN) |
| displayName | Query |
Specifies the displayed tenant organization name. |
| city | Query |
The city where the tenant organization is based. |
| state | Query |
The state where the tenant organization is based. |
| zip | Query |
Zip Code of the tenant organization location. |
| adminUserEmail | Query |
Email address of the tenant administrator. |
| tag | Query |
A unique identifier that can be used when querying APIs. |
User Management API Request Parameters
You must provide the appropriate request parameters to perform the required action or obtain the required information from the User Management API.
| Name | Type | Description |
|---|---|---|
| users | Query | Users to be managed. Defined with the usernameand idpId parameters. |
| username | Query |
Email address of the user to be added or managed. |
| idpId | Query |
Field to indicate IdP associated with a user. |
| roleNamesToAdd | Query |
User roles to be added. Refer to the tables below for a list of possible values. |
| roleNamesToRemove | Query |
User roles to be removed. Refer to the tables below for a list of possible values. |
| Provider Role | API Value |
|---|---|
| Provider Administrator | msp:provider_admin |
| Provider Operations Administrator | msp:provider_operations_admin |
| Provider Account Administrator | msp:provider_account_admin |
| Provider Billing User | msp:provider_billing_user |
| Provider Support User | msp:provider_support_user |
| Tenant Role | API Value |
|---|---|
| Tenant Administrator | msp:tenant_admin |
| Tenant User | msp:tenant_user |
| Tenant Billing User | msp:tenant_billing_user |