Extension Manager Set Service Account

Extension Manager Set Service Account

Update the stored authentication service account for the specified extension.

Updates the registration of the specified extension with the service account passed in the "serviceAccount"parameter. The service account will be used to authenticate the extension by invoking vCenter Server Login APIs and the user session can be used to update an Extension's data.

This method will unset the previous service account name associated with the extension.

The account name must be passed in with same case as the created account name. The account name must be suffixed with the vCenter machine id. The account name passed in must be qualified by the SSO domain for the vCenter server using the same format as userName for Login

NOTE: Account lifetime is managed by the extension owning the account.

Since: vSphere API Release 8.0.2.0

Required privileges: Extension.Update

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/ExtensionManager/{moId}/SetServiceAccount
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ExtensionManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Request Body
SetServiceAccountRequestType of type(s) application/json
Required
{
    "extensionKey": "string",
    "serviceAccount": "string"
}
string
extensionKey
Required

Key of extension to update.

string
serviceAccount
Required

account name qualified with SSO domain.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: if the account name described by "serviceAccount" is not present.

NotFound: if an extension specified by "extensionKey" is not registered or the service account is not found.

Returns NotFound of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}