Update Service Account

Update Service Account

Updates a service account

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

Service account ID URN

string
id
Required

Service account ID URN

Request Body
ServiceAccount of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "softwareId": "string",
    "softwareVersion": "string",
    "role": {
        "name": "string",
        "id": "string"
    },
    "uri": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "status": "string",
    "requireRotation": false
}
string
id
Optional

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

string
name
Optional

Name of the 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.

EntityReference
role
Optional

Entity reference used to describe VCD entities

string
uri
Optional

URL of a web page providing information about the client.

EntityReference
org
Optional

Entity reference used to describe VCD entities

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

boolean
requireRotation
Optional

Whether or not token rotation is required on every use of the refresh token for this service account.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ServiceAccount of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "softwareId": "string",
    "softwareVersion": "string",
    "role": {
        "name": "string",
        "id": "string"
    },
    "uri": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "status": "string",
    "requireRotation": false
}
string
id
Optional

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

string
name
Optional

Name of the 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.

EntityReference
role
Optional

Entity reference used to describe VCD entities

string
uri
Optional

URL of a web page providing information about the client.

EntityReference
org
Optional

Entity reference used to describe VCD entities

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

boolean
requireRotation
Optional

Whether or not token rotation is required on every use of the refresh token for this service account.


Availability
Added in 37.0
On This Page
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