Api

Class KeyManagementApi

java.lang.Object

Api.KeyManagementApi

public class KeyManagementApi
extends Object

Constructor Summary

Constructors

Constructor and Description
KeyManagementApi()
KeyManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2001	searchKeys(Integer offset, Integer limit, String sort, List<String> organizationIds, List<String> keyIds, List<String> keyTypes, org.joda.time.DateTime expirationStartDate, org.joda.time.DateTime expirationEndDate) Search Keys Search one or more Keys
okhttp3.Call	searchKeysAsync(Integer offset, Integer limit, String sort, List<String> organizationIds, List<String> keyIds, List<String> keyTypes, org.joda.time.DateTime expirationStartDate, org.joda.time.DateTime expirationEndDate, ApiCallback<InlineResponse2001> callback) Search Keys (asynchronously) Search one or more Keys
okhttp3.Call	searchKeysCall(Integer offset, Integer limit, String sort, List<String> organizationIds, List<String> keyIds, List<String> keyTypes, org.joda.time.DateTime expirationStartDate, org.joda.time.DateTime expirationEndDate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for searchKeys
ApiResponse<InlineResponse2001>	searchKeysWithHttpInfo(Integer offset, Integer limit, String sort, List<String> organizationIds, List<String> keyIds, List<String> keyTypes, org.joda.time.DateTime expirationStartDate, org.joda.time.DateTime expirationEndDate) Search Keys Search one or more Keys
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyManagementApi

public KeyManagementApi()

KeyManagementApi

public KeyManagementApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

searchKeysCall

public okhttp3.Call searchKeysCall(Integer offset,
                                   Integer limit,
                                   String sort,
                                   List<String> organizationIds,
                                   List<String> keyIds,
                                   List<String> keyTypes,
                                   org.joda.time.DateTime expirationStartDate,
                                   org.joda.time.DateTime expirationEndDate,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException

Build call for searchKeys

Parameters:

offset - This allows you to specify the page offset from the resulting list resultset you want the records to be returned (optional)

limit - This allows you to specify the total number of records to be returned off the resulting list resultset (optional)

sort - This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. (optional)

organizationIds - 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)

keyIds - List of Key Ids to search. The maximum size of the Key Ids list is 1 (optional)

keyTypes - Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided (optional)

expirationStartDate - Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

expirationEndDate - Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

searchKeys

public InlineResponse2001 searchKeys(Integer offset,
                                     Integer limit,
                                     String sort,
                                     List<String> organizationIds,
                                     List<String> keyIds,
                                     List<String> keyTypes,
                                     org.joda.time.DateTime expirationStartDate,
                                     org.joda.time.DateTime expirationEndDate)
                              throws ApiException

Search Keys Search one or more Keys

Parameters:

offset - This allows you to specify the page offset from the resulting list resultset you want the records to be returned (optional)

limit - This allows you to specify the total number of records to be returned off the resulting list resultset (optional)

sort - This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. (optional)

organizationIds - 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)

keyIds - List of Key Ids to search. The maximum size of the Key Ids list is 1 (optional)

keyTypes - Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided (optional)

expirationStartDate - Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

expirationEndDate - Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

Returns:

InlineResponse2001

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

searchKeysWithHttpInfo

public ApiResponse<InlineResponse2001> searchKeysWithHttpInfo(Integer offset,
                                                              Integer limit,
                                                              String sort,
                                                              List<String> organizationIds,
                                                              List<String> keyIds,
                                                              List<String> keyTypes,
                                                              org.joda.time.DateTime expirationStartDate,
                                                              org.joda.time.DateTime expirationEndDate)
                                                       throws ApiException

Search Keys Search one or more Keys

Parameters:

offset - This allows you to specify the page offset from the resulting list resultset you want the records to be returned (optional)

limit - This allows you to specify the total number of records to be returned off the resulting list resultset (optional)

sort - This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. (optional)

organizationIds - 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)

keyIds - List of Key Ids to search. The maximum size of the Key Ids list is 1 (optional)

keyTypes - Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided (optional)

expirationStartDate - Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

expirationEndDate - Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

Returns:

ApiResponse<InlineResponse2001>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

searchKeysAsync

public okhttp3.Call searchKeysAsync(Integer offset,
                                    Integer limit,
                                    String sort,
                                    List<String> organizationIds,
                                    List<String> keyIds,
                                    List<String> keyTypes,
                                    org.joda.time.DateTime expirationStartDate,
                                    org.joda.time.DateTime expirationEndDate,
                                    ApiCallback<InlineResponse2001> callback)
                             throws ApiException

Search Keys (asynchronously) Search one or more Keys

Parameters:

offset - This allows you to specify the page offset from the resulting list resultset you want the records to be returned (optional)

limit - This allows you to specify the total number of records to be returned off the resulting list resultset (optional)

sort - This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. (optional)

organizationIds - 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)

keyIds - List of Key Ids to search. The maximum size of the Key Ids list is 1 (optional)

keyTypes - Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided (optional)

expirationStartDate - Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

expirationEndDate - Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object