Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 1.92 KB

reference_element_api_addkeyservertoproviderkmip.adoc

File metadata and controls

78 lines (63 loc) · 1.92 KB
Raw
permalink sidebar keywords summary
api/reference_element_api_addkeyservertoproviderkmip.html
sidebar
KMIP,key server,assigning to key provider,assign,addkeyservertoproviderkmip
You can use the AddKeyServerToProviderKmip method to assign a Key Management Interoperability Protocol \(KMIP\) key server to the specified key provider. During assignment, the server is contacted to verify functionality. If the specified key server is already assigned to the specified key provider, no action is taken and no error is returned. You can remove the assignment using the RemoveKeyServerFromProviderKmip method.

AddKeyServerToProviderKmip

You can use the AddKeyServerToProviderKmip method to assign a Key Management Interoperability Protocol (KMIP) key server to the specified key provider. During assignment, the server is contacted to verify functionality. If the specified key server is already assigned to the specified key provider, no action is taken and no error is returned. You can remove the assignment using the RemoveKeyServerFromProviderKmip method.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

keyProviderID

The ID of the key provider to assign the key server to.

integer

None

Yes

keyServerID

The ID of the key server to assign.

integer

None

Yes

Return values

This method has no return value. The assignment is considered successful as long as there is no error returned.

Request example

Requests for this method are similar to the following example:

{
  "method": "AddKeyServerToProviderKmip",
  "params": {
    "keyProviderID": 1,
    "keyServerID": 15
    },
"id": 1
}

Response example

This method returns a response similar to the following example:

{
   "id": 1,
   "result":
      {}
    }
}

New since version

11.7