|
| 1 | +# CyberSource::AsymmetricKeyManagementApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**create_p12_keys**](AsymmetricKeyManagementApi.md#create_p12_keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS#12 keys |
| 8 | +[**delete_bulk_p12_keys**](AsymmetricKeyManagementApi.md#delete_bulk_p12_keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS#12 keys |
| 9 | +[**get_p12_key_details**](AsymmetricKeyManagementApi.md#get_p12_key_details) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS#12 key details |
| 10 | + |
| 11 | + |
| 12 | +# **create_p12_keys** |
| 13 | +> InlineResponse2011 create_p12_keys(create_p12_keys_request) |
| 14 | +
|
| 15 | +Create one or more PKCS#12 keys |
| 16 | + |
| 17 | +'Create one or more PKCS#12 keys' |
| 18 | + |
| 19 | +### Example |
| 20 | +```ruby |
| 21 | +# load the gem |
| 22 | +require 'cybersource_rest_client' |
| 23 | + |
| 24 | +api_instance = CyberSource::AsymmetricKeyManagementApi.new |
| 25 | + |
| 26 | +create_p12_keys_request = CyberSource::CreateP12KeysRequest.new # CreateP12KeysRequest | |
| 27 | + |
| 28 | + |
| 29 | +begin |
| 30 | + #Create one or more PKCS#12 keys |
| 31 | + result = api_instance.create_p12_keys(create_p12_keys_request) |
| 32 | + p result |
| 33 | +rescue CyberSource::ApiError => e |
| 34 | + puts "Exception when calling AsymmetricKeyManagementApi->create_p12_keys: #{e}" |
| 35 | +end |
| 36 | +``` |
| 37 | + |
| 38 | +### Parameters |
| 39 | + |
| 40 | +Name | Type | Description | Notes |
| 41 | +------------- | ------------- | ------------- | ------------- |
| 42 | + **create_p12_keys_request** | [**CreateP12KeysRequest**](CreateP12KeysRequest.md)| | |
| 43 | + |
| 44 | +### Return type |
| 45 | + |
| 46 | +[**InlineResponse2011**](InlineResponse2011.md) |
| 47 | + |
| 48 | +### Authorization |
| 49 | + |
| 50 | +No authorization required |
| 51 | + |
| 52 | +### HTTP request headers |
| 53 | + |
| 54 | + - **Content-Type**: application/json;charset=utf-8 |
| 55 | + - **Accept**: application/hal+json;charset=utf-8 |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +# **delete_bulk_p12_keys** |
| 60 | +> InlineResponse2003 delete_bulk_p12_keys(delete_bulk_p12_keys_request) |
| 61 | +
|
| 62 | +Delete one or more PKCS#12 keys |
| 63 | + |
| 64 | +'Delete one or more PKCS#12 keys' |
| 65 | + |
| 66 | +### Example |
| 67 | +```ruby |
| 68 | +# load the gem |
| 69 | +require 'cybersource_rest_client' |
| 70 | + |
| 71 | +api_instance = CyberSource::AsymmetricKeyManagementApi.new |
| 72 | + |
| 73 | +delete_bulk_p12_keys_request = CyberSource::DeleteBulkP12KeysRequest.new # DeleteBulkP12KeysRequest | |
| 74 | + |
| 75 | + |
| 76 | +begin |
| 77 | + #Delete one or more PKCS#12 keys |
| 78 | + result = api_instance.delete_bulk_p12_keys(delete_bulk_p12_keys_request) |
| 79 | + p result |
| 80 | +rescue CyberSource::ApiError => e |
| 81 | + puts "Exception when calling AsymmetricKeyManagementApi->delete_bulk_p12_keys: #{e}" |
| 82 | +end |
| 83 | +``` |
| 84 | + |
| 85 | +### Parameters |
| 86 | + |
| 87 | +Name | Type | Description | Notes |
| 88 | +------------- | ------------- | ------------- | ------------- |
| 89 | + **delete_bulk_p12_keys_request** | [**DeleteBulkP12KeysRequest**](DeleteBulkP12KeysRequest.md)| | |
| 90 | + |
| 91 | +### Return type |
| 92 | + |
| 93 | +[**InlineResponse2003**](InlineResponse2003.md) |
| 94 | + |
| 95 | +### Authorization |
| 96 | + |
| 97 | +No authorization required |
| 98 | + |
| 99 | +### HTTP request headers |
| 100 | + |
| 101 | + - **Content-Type**: application/json;charset=utf-8 |
| 102 | + - **Accept**: application/hal+json;charset=utf-8 |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +# **get_p12_key_details** |
| 107 | +> InlineResponse2002 get_p12_key_details(key_id) |
| 108 | +
|
| 109 | +Retrieves PKCS#12 key details |
| 110 | + |
| 111 | +Retrieves keys details by providing the key id. |
| 112 | + |
| 113 | +### Example |
| 114 | +```ruby |
| 115 | +# load the gem |
| 116 | +require 'cybersource_rest_client' |
| 117 | + |
| 118 | +api_instance = CyberSource::AsymmetricKeyManagementApi.new |
| 119 | + |
| 120 | +key_id = "key_id_example" # String | Key ID. |
| 121 | + |
| 122 | + |
| 123 | +begin |
| 124 | + #Retrieves PKCS#12 key details |
| 125 | + result = api_instance.get_p12_key_details(key_id) |
| 126 | + p result |
| 127 | +rescue CyberSource::ApiError => e |
| 128 | + puts "Exception when calling AsymmetricKeyManagementApi->get_p12_key_details: #{e}" |
| 129 | +end |
| 130 | +``` |
| 131 | + |
| 132 | +### Parameters |
| 133 | + |
| 134 | +Name | Type | Description | Notes |
| 135 | +------------- | ------------- | ------------- | ------------- |
| 136 | + **key_id** | **String**| Key ID. | |
| 137 | + |
| 138 | +### Return type |
| 139 | + |
| 140 | +[**InlineResponse2002**](InlineResponse2002.md) |
| 141 | + |
| 142 | +### Authorization |
| 143 | + |
| 144 | +No authorization required |
| 145 | + |
| 146 | +### HTTP request headers |
| 147 | + |
| 148 | + - **Content-Type**: application/json;charset=utf-8 |
| 149 | + - **Accept**: application/hal+json;charset=utf-8 |
| 150 | + |
| 151 | + |
| 152 | + |
0 commit comments