Extension Manager Set Extension Certificate

Update the stored authentication certificate for a specified extension.

Updates the registration of the specified extension with the thumbprint of the X.509 client certificate provided over SSL handshake, or by the "certificatePem"argument. The thumbprint will be used to authenticate the extension during invocations of LoginExtensionByCertificate.

NOTE: No verification is performed on the received certificate, such as expiry or revocation.

This method will unset any public key or subject name associated with the extension.

Required privileges: Extension.Update

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ExtensionManager/{moId}/SetExtensionCertificate

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.2.0 APIs.

Request Body

SetExtensionCertificateRequestType of type(s) application/json

Required

{
    "extensionKey": "string",
    "certificatePem": "string"
}

string

extensionKey

Required

Key of extension to update.

string

certificatePem

Optional

PEM encoded certificate. If not specified, the certificate passed over SSL handshake is used.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: if the certificate described by "certificatePem" is not in PEM format, or could not be decoded to an X.509 certificate.

NoClientCertificate: if certificatePem is not specified, and no certificate was passed over SSL handshake.

NotFound: if an extension specified by "extensionKey" is not registered.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Extension Manager Operations

POST

Extension Manager Find Extension