Update Service Account

Update Service Account
Updates a 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

Request Body
ServiceAccount of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "softwareId": "string",
    "softwareVersion": "string",
    "roles": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "uri": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "managedBy": {
        "name": "string",
        "id": "string"
    },
    "status": "string",
    "requireRotation": false,
    "tokenRotation": "string"
}
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.

array of object
roles
Optional
Constraints: maxItems: 128

Entity references of the Roles assigned to this service account.

string
uri
Optional

URL of a web page providing information about the client.

object
org
Optional

Entity reference used to describe VCD entities

object
managedBy
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.

string
tokenRotation
Optional

Defines the token rotation behavior. ALWAYS: Tokens are rotated automatically when requireRotation=true. NEVER: Tokens are never rotated (requireRotation=false). ONCE_ON_NEXT_LOGIN: Token rotates on the next login, then resets to NEVER by the server (requireRotation=false). NONE: Not applicable.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ServiceAccount of type(s) application/json;version=9.1.0 
{
    "id": "string",
    "name": "string",
    "softwareId": "string",
    "softwareVersion": "string",
    "roles": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "uri": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "managedBy": {
        "name": "string",
        "id": "string"
    },
    "status": "string",
    "requireRotation": false,
    "tokenRotation": "string"
}

Vendor Extension

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

                    [{"type":"Classic"},{"type":"Modern"}]
Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/cloudapi/1.0.0/serviceAccounts/{id}
Availability
Added in 37.0
On This Page
Service Account Operations
GET
Query Service Accounts
GET
Get Service Account
PUT
Update Service Account
DELETE
Delete Service Account
POST
Revoke Service Account
POST
Take Ownership