|
| 1 | +# CyberSource::KeymanagementApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**search_keys**](KeymanagementApi.md#search_keys) | **GET** /kms/v2/keys | Search Keys |
| 8 | + |
| 9 | + |
| 10 | +# **search_keys** |
| 11 | +> InlineResponse200 search_keys(opts) |
| 12 | +
|
| 13 | +Search Keys |
| 14 | + |
| 15 | +Search one or more Keys |
| 16 | + |
| 17 | +### Example |
| 18 | +```ruby |
| 19 | +# load the gem |
| 20 | +require 'cybersource_rest_client' |
| 21 | + |
| 22 | +api_instance = CyberSource::KeymanagementApi.new |
| 23 | + |
| 24 | +opts = { |
| 25 | + offset: 56, # Integer | This allows you to specify the page offset from the resulting list resultset you want the records to be returned |
| 26 | + limit: 56, # Integer | This allows you to specify the total number of records to be returned off the resulting list resultset |
| 27 | + sort: "sort_example", # String | This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. |
| 28 | + organization_ids: ["organization_ids_example"], # Array<String> | List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. |
| 29 | + key_ids: ["key_ids_example"], # Array<String> | List of Key Ids to search. The maximum size of the Key Ids list is 1 |
| 30 | + key_types: ["key_types_example"], # Array<String> | Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided |
| 31 | + expiration_start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 32 | + expiration_end_date: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 33 | +} |
| 34 | + |
| 35 | +begin |
| 36 | + #Search Keys |
| 37 | + result = api_instance.search_keys(opts) |
| 38 | + p result |
| 39 | +rescue CyberSource::ApiError => e |
| 40 | + puts "Exception when calling KeymanagementApi->search_keys: #{e}" |
| 41 | +end |
| 42 | +``` |
| 43 | + |
| 44 | +### Parameters |
| 45 | + |
| 46 | +Name | Type | Description | Notes |
| 47 | +------------- | ------------- | ------------- | ------------- |
| 48 | + **offset** | **Integer**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional] |
| 49 | + **limit** | **Integer**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional] |
| 50 | + **sort** | **String**| This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. | [optional] |
| 51 | + **organization_ids** | [**Array<String>**](String.md)| List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. | [optional] |
| 52 | + **key_ids** | [**Array<String>**](String.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional] |
| 53 | + **key_types** | [**Array<String>**](String.md)| Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided | [optional] |
| 54 | + **expiration_start_date** | **DateTime**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 55 | + **expiration_end_date** | **DateTime**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 56 | + |
| 57 | +### Return type |
| 58 | + |
| 59 | +[**InlineResponse200**](InlineResponse200.md) |
| 60 | + |
| 61 | +### Authorization |
| 62 | + |
| 63 | +No authorization required |
| 64 | + |
| 65 | +### HTTP request headers |
| 66 | + |
| 67 | + - **Content-Type**: application/json;charset=utf-8 |
| 68 | + - **Accept**: application/hal+json;charset=utf-8 |
| 69 | + |
| 70 | + |
| 71 | + |
0 commit comments