Crypto Manager Kmip Set Key Custom Attributes

Crypto Manager Kmip Set Key Custom Attributes
Set crypto key's custom attributes.

Set crypto key's custom attributes.

Since: vSphere API Release 8.0.1.0

Required privileges: Cryptographer.ManageKeys

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/CryptoManagerKmip/{moId}/SetKeyCustomAttributes
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 CryptoManagerKmip/{moId}.

string
release
Required

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

Request Body
SetKeyCustomAttributesRequestType of type(s) application/json
Required

Show optional properties

{
    "keyId": {},
    "spec": {}
}
{
    "keyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "spec": {
        "_typeName": "string",
        "attributes": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ]
    }
}
keyId
Required

[in] The crypto Key Id.

spec
Required

[in] The spec that contains custom attributes key/value pairs.

Authentication
This operation uses the following authentication methods.
Responses
200

The structure combined with status and fail reason.

Returns CryptoKeyResult of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "keyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "success": false,
    "reason": "string",
    "fault": {
        "_typeName": "string",
        "faultCause": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        },
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    }
}
object
keyId
Required

Data Object representing a cryptographic key.

boolean
success
Required

success

string
reason
Optional

reason

fault
Optional

Fault which includes details about the error.

Since: vSphere API Release 7.0.1.0


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"keyId":"{}","spec":"{}"}' https://{api_host}/sdk/vim25/{release}/CryptoManagerKmip/{moId}/SetKeyCustomAttributes
Availability
Added in vSphere API Release 8.0.1.0
On This Page
Virtual Infrastructure Operations
POST
Crypto Manager Kmip Is Kms Cluster Active
POST
Crypto Manager Kmip Add Key
POST
Crypto Manager Kmip Add Keys
POST
Crypto Manager Kmip Generate Client Csr
POST
Crypto Manager Kmip Generate Key
POST
Crypto Manager Kmip Generate Self Signed Client Cert
POST
Crypto Manager Kmip Get Default Kms Cluster
POST
Crypto Manager Kmip List Keys
POST
Crypto Manager Kmip List Kmip Servers
POST
Crypto Manager Kmip List Kms Clusters
POST
Crypto Manager Kmip Mark Default
POST
Crypto Manager Kmip Query Crypto Key Status
POST
Crypto Manager Kmip Register Kmip Server
POST
Crypto Manager Kmip Register Kms Cluster
POST
Crypto Manager Kmip Remove Key
POST
Crypto Manager Kmip Remove Keys
POST
Crypto Manager Kmip Remove Kmip Server
POST
Crypto Manager Kmip Retrieve Client Cert
POST
Crypto Manager Kmip Retrieve Client Csr
POST
Crypto Manager Kmip Retrieve Kmip Server Cert
POST
Crypto Manager Kmip Retrieve Kmip Servers Status Task
POST
Crypto Manager Kmip Retrieve Self Signed Client Cert
POST
Crypto Manager Kmip Set Default Kms Cluster
POST
Crypto Manager Kmip Set Key Custom Attributes
POST
Crypto Manager Kmip Unregister Kms Cluster
POST
Crypto Manager Kmip Update Kmip Server
POST
Crypto Manager Kmip Update Kms Signed Csr Client Cert
POST
Crypto Manager Kmip Update Self Signed Client Cert
POST
Crypto Manager Kmip Upload Client Cert
POST
Crypto Manager Kmip Upload Kmip Server Cert
GET
Crypto Manager Kmip Get Enabled
GET
Crypto Manager Kmip Get Kmip Servers