com.cyberark.conjur.sdk.endpoint

Class PublicKeysApi

java.lang.Object

com.cyberark.conjur.sdk.endpoint.PublicKeysApi

public class PublicKeysApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PublicKeysApi()
PublicKeysApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
String	showPublicKeys(String account, String kind, String identifier) Shows all public keys for a resource.
String	showPublicKeys(String account, String kind, String identifier, String xRequestId) Shows all public keys for a resource.
okhttp3.Call	showPublicKeysAsync(String account, String kind, String identifier, String xRequestId, ApiCallback<String> _callback) Shows all public keys for a resource.
okhttp3.Call	showPublicKeysCall(String account, String kind, String identifier, String xRequestId, ApiCallback _callback) Build call for showPublicKeys
ApiResponse<String>	showPublicKeysWithHttpInfo(String account, String kind, String identifier) Shows all public keys for a resource.
ApiResponse<String>	showPublicKeysWithHttpInfo(String account, String kind, String identifier, String xRequestId) Shows all public keys for a resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicKeysApi

public PublicKeysApi()

PublicKeysApi

public PublicKeysApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

showPublicKeysCall

public okhttp3.Call showPublicKeysCall(String account,
                                       String kind,
                                       String identifier,
                                       String xRequestId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for showPublicKeys

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the resource for which to get the information about (required)

xRequestId - Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-

showPublicKeys

public String showPublicKeys(String account,
                             String kind,
                             String identifier,
                             String xRequestId)
                      throws ApiException

Shows all public keys for a resource. Shows all public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Returns an empty string if the resource does not exist, to prevent attackers from determining whether a resource exists.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the resource for which to get the information about (required)

xRequestId - Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)

Returns:

String

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-

showPublicKeys

public String showPublicKeys(String account,
                             String kind,
                             String identifier)
                      throws ApiException

Shows all public keys for a resource. Shows all public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Returns an empty string if the resource does not exist, to prevent attackers from determining whether a resource exists.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the resource for which to get the information about

Returns:

String

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-

showPublicKeysWithHttpInfo

public ApiResponse<String> showPublicKeysWithHttpInfo(String account,
                                                      String kind,
                                                      String identifier,
                                                      String xRequestId)
                                               throws ApiException

Shows all public keys for a resource. Shows all public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Returns an empty string if the resource does not exist, to prevent attackers from determining whether a resource exists.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the resource for which to get the information about (required)

xRequestId - Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)

Returns:

ApiResponse<String>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-

showPublicKeysWithHttpInfo

public ApiResponse<String> showPublicKeysWithHttpInfo(String account,
                                                      String kind,
                                                      String identifier)
                                               throws ApiException

Shows all public keys for a resource. Shows all public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Returns an empty string if the resource does not exist, to prevent attackers from determining whether a resource exists.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the resource for which to get the information about

Returns:

ApiResponse<String>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-

showPublicKeysAsync

public okhttp3.Call showPublicKeysAsync(String account,
                                        String kind,
                                        String identifier,
                                        String xRequestId,
                                        ApiCallback<String> _callback)
                                 throws ApiException

Shows all public keys for a resource. (asynchronously) Shows all public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Returns an empty string if the resource does not exist, to prevent attackers from determining whether a resource exists.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the resource for which to get the information about (required)

xRequestId - Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (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

Http Response Details:

Status Code	Description	Response Headers
200	Public keys for a resource as newline delimited string for compatibility with the authorized_keys SSH format. Empty string if the resource does not exist	-
400	The server cannot process the request due to malformed request syntax	-
404	The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set	-
422	A request parameter was either missing or invalid.	-
500	Malfromed request, rejected by the server	-