|
| 1 | +# KeyManagementApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**searchKeys**](KeyManagementApi.md#searchKeys) | **GET** /kms/v2/keys | Search Keys |
| 8 | + |
| 9 | + |
| 10 | +<a name="searchKeys"></a> |
| 11 | +# **searchKeys** |
| 12 | +> InlineResponse200 searchKeys(offset, limit, sort, organizationIds, keyIds, keyTypes, expirationStartDate, expirationEndDate) |
| 13 | +
|
| 14 | +Search Keys |
| 15 | + |
| 16 | +Search one or more Keys |
| 17 | + |
| 18 | +### Example |
| 19 | +```java |
| 20 | +// Import classes: |
| 21 | +//import Invokers.ApiException; |
| 22 | +//import Api.KeyManagementApi; |
| 23 | + |
| 24 | + |
| 25 | +KeyManagementApi apiInstance = new KeyManagementApi(); |
| 26 | +Integer offset = 56; // Integer | This allows you to specify the page offset from the resulting list resultset you want the records to be returned |
| 27 | +Integer limit = 56; // Integer | This allows you to specify the total number of records to be returned off the resulting list resultset |
| 28 | +String 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. |
| 29 | +List<String> organizationIds = Arrays.asList("organizationIds_example"); // List<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. |
| 30 | +List<String> keyIds = Arrays.asList("keyIds_example"); // List<String> | List of Key Ids to search. The maximum size of the Key Ids list is 1 |
| 31 | +List<String> keyTypes = Arrays.asList("keyTypes_example"); // List<String> | Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided |
| 32 | +DateTime expirationStartDate = new DateTime(); // DateTime | Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 33 | +DateTime expirationEndDate = new DateTime(); // DateTime | Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 34 | +try { |
| 35 | + InlineResponse200 result = apiInstance.searchKeys(offset, limit, sort, organizationIds, keyIds, keyTypes, expirationStartDate, expirationEndDate); |
| 36 | + System.out.println(result); |
| 37 | +} catch (ApiException e) { |
| 38 | + System.err.println("Exception when calling KeyManagementApi#searchKeys"); |
| 39 | + e.printStackTrace(); |
| 40 | +} |
| 41 | +``` |
| 42 | + |
| 43 | +### Parameters |
| 44 | + |
| 45 | +Name | Type | Description | Notes |
| 46 | +------------- | ------------- | ------------- | ------------- |
| 47 | + **offset** | **Integer**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional] |
| 48 | + **limit** | **Integer**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional] |
| 49 | + **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] |
| 50 | + **organizationIds** | [**List<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] |
| 51 | + **keyIds** | [**List<String>**](String.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional] |
| 52 | + **keyTypes** | [**List<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] |
| 53 | + **expirationStartDate** | **DateTime**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 54 | + **expirationEndDate** | **DateTime**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 55 | + |
| 56 | +### Return type |
| 57 | + |
| 58 | +[**InlineResponse200**](InlineResponse200.md) |
| 59 | + |
| 60 | +### Authorization |
| 61 | + |
| 62 | +No authorization required |
| 63 | + |
| 64 | +### HTTP request headers |
| 65 | + |
| 66 | + - **Content-Type**: application/json;charset=utf-8 |
| 67 | + - **Accept**: application/hal+json;charset=utf-8 |
| 68 | + |
0 commit comments