permalink | sidebar | keywords | summary |
---|---|---|---|
api/reference_element_api_createkeyproviderkmip.html |
sidebar |
KMIP,key provider,creating,create |
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. |
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
.
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 |
This method has the following return values:
Name |
Description |
Type |
kmipKeyProvider |
An object containing details about the newly created key provider. |
Requests for this method are similar to the following example:
{ "method": "CreateKeyProviderKmip", "params": { "keyProviderName": "ProviderName", }, "id": 1 }
This method returns a response similar to the following example:
{ "id": 1, "result": { "kmipKeyProvider": { "keyProviderName": "ProviderName", "keyProviderIsActive": true, "kmipCapabilities": "SSL", "keyServerIDs": [ 15 ], "keyProviderID": 1 } } }