[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Update Service Account

Description

Updates a service account

Request

URL

put

https://{api_host}/cloudapi/1.0.0/serviceAccounts/{id}

Copy

Path Parameters

string

id Required

Service account ID URN

Request Body

ServiceAccount of type(s) application/json Required

{
	"id": "string",
	"name": "string",
	"org": {
		"id": "string",
		"name": "string"
	},
	"role": {
		"id": "string",
		"name": "string"
	},
	"softwareId": "string",
	"softwareVersion": "string",
	"status": "string",
	"uri": "string"
}

string

id Changed Optional

ID of this service account. Sorting on this field is not supported.

string

name Optional

Name of the service account.

EntityReference

org Optional

Entity reference used to describe VCD entities

EntityReference

role Optional

Entity reference of the Role assigned to this service account.

string

softwareId Optional

Unique identifier string to identify the client software being registered.

string

softwareVersion Optional

Version identifier string for the client software identified by software_id.

string

status Optional

The status of the refresh token for this service account. CREATED: The client exists with no refresh token and no user codes REQUESTED: The client exists with no refresh token and has user codes GRANTED: The client exists with no refresh token and has a single user code marked as granted ACTIVE: The client exists with refresh token

string

uri Optional

URL of a web page providing information about the client.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns ServiceAccount of type(s) application/json;version=37.2

{
	"id": "string",
	"name": "string",
	"org": {
		"id": "string",
		"name": "string"
	},
	"role": {
		"id": "string",
		"name": "string"
	},
	"softwareId": "string",
	"softwareVersion": "string",
	"status": "string",
	"uri": "string"
}

string

id Changed Optional

ID of this service account. Sorting on this field is not supported.

string

name Optional

Name of the service account.

EntityReference

org Optional

Entity reference used to describe VCD entities

EntityReference

role Optional

Entity reference of the Role assigned to this service account.

string

softwareId Optional

Unique identifier string to identify the client software being registered.

string

softwareVersion Optional

Version identifier string for the client software identified by software_id.

string

status Optional

string

uri Optional

URL of a web page providing information about the client.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"id":"string","name":"string","org":{"id":"string","name":"string"},"role":{"id":"string","name":"string"},"softwareId":"string","softwareVersion":"string","status":"string","uri":"string"}' https://{api_host}/cloudapi/1.0.0/serviceAccounts/{id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-event: com/vmware/vcloud/event/serviceAccount/modify

vmware-cloud-director

Availability

Added in 37.0

Service Account Operations

delete

Delete Service Account

get

Get Service Account

get

Query Service Accounts

post

Revoke Service Account

post

Take Ownership

put

Update Service Account

Update Service Account

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

Availability

On This Page

Service Account Operations

Was this page helpful?