new KeyApi()
- Version:
- 1.0
Key service.
Methods
getKey(callback)
Get key Retrieve the created keys.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
KeyApi~getKeyCallback | The callback function, accepting three arguments: error, data, response data is of type: Key |
keyCreation(opts, callback)
Key Creation Creates up to 100 keys in batches.
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
KeyApi~keyCreationCallback | The callback function, accepting three arguments: error, data, response data is of type: KeyCreationResponse |
keyDeletion(callback)
Key deletion Delete a key.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
KeyApi~keyDeletionCallback | The callback function, accepting three arguments: error, data, response data is of type: KeyStatus |
keySignData(opts, callback)
Sign data using keys Sign the data using keys.
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
KeyApi~keySignDataCallback | The callback function, accepting three arguments: error, data, response data is of type: KeySignDataResponse |
retrieveKeys(opts, callback)
Retrieve a list of keys. Returns a list of keys
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
KeyApi~retrieveKeysCallback | The callback function, accepting three arguments: error, data, response data is of type: KeyList |
Type Definitions
getKeyCallback(error, data, response)
Callback function to receive the result of the getKey operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Key | The data returned by the service call. |
response |
String | The complete HTTP response. |
keyCreationCallback(error, data, response)
Callback function to receive the result of the keyCreation operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
KeyCreationResponse | The data returned by the service call. |
response |
String | The complete HTTP response. |
keyDeletionCallback(error, data, response)
Callback function to receive the result of the keyDeletion operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
KeyStatus | The data returned by the service call. |
response |
String | The complete HTTP response. |
keySignDataCallback(error, data, response)
Callback function to receive the result of the keySignData operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
KeySignDataResponse | The data returned by the service call. |
response |
String | The complete HTTP response. |
retrieveKeysCallback(error, data, response)
Callback function to receive the result of the retrieveKeys operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
KeyList | The data returned by the service call. |
response |
String | The complete HTTP response. |