Update Service App

Update Service App

Updates a specific VMware service application.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/serviceApps/{serviceAppId}
COPY
Path Parameters
string
serviceAppId
Required

serviceAppId

string
serviceAppId
Required

serviceAppId

Request Body
ServiceApp of type(s) application/json
Optional 
{
    "id": "string",
    "name": "string",
    "clientId": "string",
    "clientSecret": "string",
    "orgId": "string",
    "serviceScope": {},
    "accessTokenTTL": 0,
    "accessTokenExpiration": "string",
    "enabled": false,
    "authorizationUrl": "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize"
}
string
id
Optional

The unique ID for the service application. This field is read-only.

string
name
Required

The name of the service application

string
clientId
Required

The client ID

string
clientSecret
Required

The client secret

string
orgId
Optional

The external organization id of the service application

ServiceAppScope
serviceScope
Required

Describes the type of service application. VMC_REFRESH_TOKEN: The application authtenticates to VMC via a refresh token VMC_CLIENT_CREDENTIAL: The application authenticates to VMC using client credentials VMC: Deprecated. Defaults to VMC_REFRESH_TOKEN.

Possible values are : VMC, VMC_REFRESH_TOKEN, VMC_CLIENT_CREDENTIAL,
integer
accessTokenTTL
Optional

The read-only time-to-live of the access token in seconds.

string As date-time As date-time
accessTokenExpiration
Optional

The read-only expiration date of the access token.

boolean
enabled
Optional

Whether the application is currently enabled.

string
authorizationUrl
Optional

The authorization URL for the application.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ServiceApp of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "clientId": "string",
    "clientSecret": "string",
    "orgId": "string",
    "serviceScope": {},
    "accessTokenTTL": 0,
    "accessTokenExpiration": "string",
    "enabled": false,
    "authorizationUrl": "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize"
}
string
id
Optional

The unique ID for the service application. This field is read-only.

string
name
Required

The name of the service application

string
clientId
Required

The client ID

string
clientSecret
Required

The client secret

string
orgId
Optional

The external organization id of the service application

ServiceAppScope
serviceScope
Required

Describes the type of service application. VMC_REFRESH_TOKEN: The application authtenticates to VMC via a refresh token VMC_CLIENT_CREDENTIAL: The application authenticates to VMC using client credentials VMC: Deprecated. Defaults to VMC_REFRESH_TOKEN.

Possible values are : VMC, VMC_REFRESH_TOKEN, VMC_CLIENT_CREDENTIAL,
integer
accessTokenTTL
Optional

The read-only time-to-live of the access token in seconds.

string As date-time As date-time
accessTokenExpiration
Optional

The read-only expiration date of the access token.

boolean
enabled
Optional

Whether the application is currently enabled.

string
authorizationUrl
Optional

The authorization URL for the application.


400

Invalid configuration.

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
Service App Operations
DELETE
Delete Service App
GET
Get Service App
PUT
Update Service App