permalink | sidebar | keywords | summary |
---|---|---|---|
api/reference_element_api_listkeyserverskmip.html |
sidebar |
KMIP,key server,key,server,listing,list,listkeyserverskmip |
You can use the ListKeyServersKmip method to list all Key Management Interoperability Protocol \(KMIP\) key servers that have been created. You can filter the results by specifying additional parameters. |
You can use the ListKeyServersKmip
method to list all Key Management Interoperability Protocol (KMIP) key servers that have been created. You can filter the results by specifying additional parameters.
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
keyProviderID |
When specified, the method only returns KMIP key servers that are assigned to the specified KMIP key provider. If omitted, returned KMIP key servers will not be filtered based on whether they are assigned to the specified KMIP Key Provider. |
integer |
None |
No |
kmipAssignedProviderIsActive |
Filters returned KMIP key server objects based on whether they are active. Possible values:
If omitted, returned KMIP key servers are not filtered based on whether they are active. |
boolean |
None |
No |
kmipHasProviderAssigned |
Filters returned KMIP key servers based on whether they have a KMIP key provider assigned. Possible values:
If omitted, returned KMIP key servers are not filtered based on whether they have a KMIP key provider assigned. |
boolean |
None |
No |
This method has the following return values:
Name |
Description |
Type |
kmipKeyServers |
The complete list of KMIP key servers which have been created. |
KeyServerKmip array |
Requests for this method are similar to the following example:
{ "method": "ListKeyServersKmip", "params": {}, "id": 1 }
This method returns a response similar to the following example:
{ "kmipKeyServers": [ { "kmipKeyServerName": "keyserverName", "kmipClientCertificate": "dKkkirWmnWXbj9T/UWZYB2oK0z5...", "keyServerID": 15, "kmipAssignedProviderIsActive": true, "kmipKeyServerPort": 5696, "kmipCaCertificate": "MIICPDCCAaUCEDyRMcsf9tAbDpq40ES/E...", "kmipKeyServerHostnames": [ "server1.hostname.com", "server2.hostname.com" ], "keyProviderID": 1 } ] }