CreateKeyProviderKmip
Suggest changes
PDFs
You can use the CreateKeyProviderKmip method to create a Key Management Interoperability Protocol (KMIP) key provider with the specified name. A key provider defines a mechanism and location to retrieve authentication keys. When you create a new KMIP key provider, it does not have any KMIP key servers assigned to it. To create a KMIP key server, use the CreateKeyServerKmip method. To assign it to a provider, see AddKeyServerToProviderKmip.
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
keyProviderName |
The name to associate with the created KMIP key provider. This name is only used for display purposes and does not need to be unique. |
string |
None |
Yes |
Return values
This method has the following return values:
Name |
Description |
Type |
kmipKeyProvider |
An object containing details about the newly created key provider. |
Request example
Requests for this method are similar to the following example:
{
"method": "CreateKeyProviderKmip",
"params": {
"keyProviderName": "ProviderName",
},
"id": 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result":
{
"kmipKeyProvider": {
"keyProviderName": "ProviderName",
"keyProviderIsActive": true,
"kmipCapabilities": "SSL",
"keyServerIDs": [
15
],
"keyProviderID": 1
}
}
}
New since version
11.7