|
| 1 | +# CyberSource.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(opts) |
| 13 | +
|
| 14 | +Search Keys |
| 15 | + |
| 16 | +Search one or more Keys |
| 17 | + |
| 18 | +### Example |
| 19 | +```javascript |
| 20 | +var CyberSource = require('CyberSource'); |
| 21 | + |
| 22 | +var apiInstance = new CyberSource.KeyManagementApi(); |
| 23 | + |
| 24 | +var opts = { |
| 25 | + 'offset': 56, // Number | This allows you to specify the page offset from the resulting list resultset you want the records to be returned |
| 26 | + 'limit': 56, // Number | 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 | + 'organizationIds': ["organizationIds_example"], // [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 | + 'keyIds': ["keyIds_example"], // [String] | List of Key Ids to search. The maximum size of the Key Ids list is 1 |
| 30 | + 'keyTypes': ["keyTypes_example"], // [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 | + 'expirationStartDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 32 | + 'expirationEndDate': new Date("2013-10-20T19:20:30+01:00") // Date | Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided |
| 33 | +}; |
| 34 | + |
| 35 | +var callback = function(error, data, response) { |
| 36 | + if (error) { |
| 37 | + console.error(error); |
| 38 | + } else { |
| 39 | + console.log('API called successfully. Returned data: ' + data); |
| 40 | + } |
| 41 | +}; |
| 42 | +apiInstance.searchKeys(opts, callback); |
| 43 | +``` |
| 44 | + |
| 45 | +### Parameters |
| 46 | + |
| 47 | +Name | Type | Description | Notes |
| 48 | +------------- | ------------- | ------------- | ------------- |
| 49 | + **offset** | **Number**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional] |
| 50 | + **limit** | **Number**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional] |
| 51 | + **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] |
| 52 | + **organizationIds** | [**[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] |
| 53 | + **keyIds** | [**[String]**](String.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional] |
| 54 | + **keyTypes** | [**[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] |
| 55 | + **expirationStartDate** | **Date**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 56 | + **expirationEndDate** | **Date**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 57 | + |
| 58 | +### Return type |
| 59 | + |
| 60 | +[**InlineResponse200**](InlineResponse200.md) |
| 61 | + |
| 62 | +### Authorization |
| 63 | + |
| 64 | +No authorization required |
| 65 | + |
| 66 | +### HTTP request headers |
| 67 | + |
| 68 | + - **Content-Type**: application/json;charset=utf-8 |
| 69 | + - **Accept**: application/hal+json;charset=utf-8 |
| 70 | + |
0 commit comments