reference_element_api_getkeyproviderkmip.adoc

permalink	sidebar	keywords	summary
api/reference_element_api_getkeyproviderkmip.html	sidebar	KMIP,key provider,retrieving,get,retrieve	You can use the GetKeyProviderKmip method to retrieve information about the specified Key Management Interoperability Protocol \(KMIP\) key provider.

GetKeyProviderKmip

You can use the GetKeyProviderKmip method to retrieve information about the specified Key Management Interoperability Protocol (KMIP) key provider.

Parameters

This method has the following input parameters:

Name	Description	Type	Default value	Required
keyProviderID	The ID of the KMIP key provider object to return.	integer	None	Yes

Return values

This method has the following return values:

Name	Description	Type
kmipKeyProvider	An object containing details about the requested key provider.	KeyProviderKmip

Request example

Requests for this method are similar to the following example:

{
  "method": "GetKeyProviderKmip",
  "params": {
    "keyProviderID": 15
    },
"id": 1
}

Response example

This method returns a response similar to the following example:

{
   "id": 1,
   "result":
    {
    "kmipKeyProvider": {
        "keyProviderID": 15,
        "kmipCapabilities": "SSL",
        "keyProviderIsActive": true,
        "keyServerIDs": [
            1
        ],
        "keyProviderName": "ProviderName"
    }
   }
}

New since version

11.7