|
| 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 | +# **searchKeys** |
| 11 | +> \CyberSource\Model\InlineResponse200 searchKeys($offset, $limit, $sort, $organizationIds, $keyIds, $keyTypes, $expirationStartDate, $expirationEndDate) |
| 12 | +
|
| 13 | +Search Keys |
| 14 | + |
| 15 | +Search one or more Keys |
| 16 | + |
| 17 | +### Example |
| 18 | +```php |
| 19 | +<?php |
| 20 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 21 | + |
| 22 | +$api_instance = new CyberSource\Api\KeymanagementApi(); |
| 23 | +$offset = 56; // int | This allows you to specify the page offset from the resulting list resultset you want the records to be returned |
| 24 | +$limit = 56; // int | This allows you to specify the total number of records to be returned off the resulting list resultset |
| 25 | +$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. |
| 26 | +$organizationIds = array("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. |
| 27 | +$keyIds = array("keyIds_example"); // string[] | List of Key Ids to search. The maximum size of the Key Ids list is 1 |
| 28 | +$keyTypes = array("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 |
| 29 | +$expirationStartDate = new \DateTime("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 |
| 30 | +$expirationEndDate = new \DateTime("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 |
| 31 | + |
| 32 | +try { |
| 33 | + $result = $api_instance->searchKeys($offset, $limit, $sort, $organizationIds, $keyIds, $keyTypes, $expirationStartDate, $expirationEndDate); |
| 34 | + print_r($result); |
| 35 | +} catch (Exception $e) { |
| 36 | + echo 'Exception when calling KeymanagementApi->searchKeys: ', $e->getMessage(), PHP_EOL; |
| 37 | +} |
| 38 | +?> |
| 39 | +``` |
| 40 | + |
| 41 | +### Parameters |
| 42 | + |
| 43 | +Name | Type | Description | Notes |
| 44 | +------------- | ------------- | ------------- | ------------- |
| 45 | + **offset** | **int**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional] |
| 46 | + **limit** | **int**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional] |
| 47 | + **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] |
| 48 | + **organizationIds** | [**string[]**](../Model/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] |
| 49 | + **keyIds** | [**string[]**](../Model/string.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional] |
| 50 | + **keyTypes** | [**string[]**](../Model/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] |
| 51 | + **expirationStartDate** | **\DateTime**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 52 | + **expirationEndDate** | **\DateTime**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] |
| 53 | + |
| 54 | +### Return type |
| 55 | + |
| 56 | +[**\CyberSource\Model\InlineResponse200**](../Model/InlineResponse200.md) |
| 57 | + |
| 58 | +### Authorization |
| 59 | + |
| 60 | +No authorization required |
| 61 | + |
| 62 | +### HTTP request headers |
| 63 | + |
| 64 | + - **Content-Type**: application/json;charset=utf-8 |
| 65 | + - **Accept**: application/hal+json;charset=utf-8 |
| 66 | + |
| 67 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 68 | + |
0 commit comments