Create Service App
Create a VMware service app
Request
URLURL
https://{api_host}/cloudapi/1.0.0/serviceApps
Request Body
Request Body
ServiceApp of type(s) application/json
Required
A VMware service application
(The request body parameter is missing description)
{
"clientId": "string",
"clientSecret": "string",
"name": "string",
"serviceScope": "enum"
}
string
name
Required
The name of the service application
string
clientId
Required
The client ID
string
clientSecret
Required
The client secret
serviceScope
Required
The scope of the service application
Possible values are: VMC , VMC_REFRESH_TOKEN , VMC_CLIENT_CREDENTIAL
string
accessTokenExpiration
Optional
The read-only expiration date of the access token.
string
authorizationUrl
Introduced
Changed
Optional
The authorization URL for the application.
boolean
enabled
Optional
Whether the application is currently enabled.
string
id
Optional
The unique ID for the service application. This field is read-only.
integer
accessTokenTTL
Optional
The read-only time-to-live of the access token in seconds.
string
orgId
Optional
The external organization id of the service application
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
ServiceApp of type(s) application/json;version=36.1
{
"accessTokenExpiration": "string",
"accessTokenTTL": 0,
"authorizationUrl": "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize",
"clientId": "string",
"clientSecret": "string",
"enabled": false,
"id": "string",
"name": "string",
"orgId": "string",
"serviceScope": "enum"
}
string
name
Required
The name of the service application
string
clientId
Required
The client ID
string
clientSecret
Required
The client secret
serviceScope
Required
The scope of the service application
Possible values are: VMC , VMC_REFRESH_TOKEN , VMC_CLIENT_CREDENTIAL
string
accessTokenExpiration
Optional
The read-only expiration date of the access token.
string
authorizationUrl
Introduced
Changed
Optional
The authorization URL for the application.
boolean
enabled
Optional
Whether the application is currently enabled.
string
id
Optional
The unique ID for the service application. This field is read-only.
integer
accessTokenTTL
Optional
The read-only time-to-live of the access token in seconds.
string
orgId
Optional
The external organization id of the service application
Errors
Code SamplesCode Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"accessTokenExpiration":"string","accessTokenTTL":0,"authorizationUrl":"https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize","clientId":"string","clientSecret":"string","enabled":false,"id":"string","name":"string","orgId":"string","serviceScope":"enum"}' https://{api_host}/cloudapi/1.0.0/serviceApps
Availability
Added in 32.0
On This Page
Service Apps Operations
post
