com.cyberark.conjur.sdk.endpoint

Class CertificateAuthorityApi

java.lang.Object

com.cyberark.conjur.sdk.endpoint.CertificateAuthorityApi

public class CertificateAuthorityApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CertificateAuthorityApi()
CertificateAuthorityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
CertificateJson	sign(String account, String serviceId, String csr, String ttl) Gets a signed certificate from the configured Certificate Authority service.
CertificateJson	sign(String account, String serviceId, String csr, String ttl, String accept, String xRequestId) Gets a signed certificate from the configured Certificate Authority service.
okhttp3.Call	signAsync(String account, String serviceId, String csr, String ttl, String accept, String xRequestId, ApiCallback<CertificateJson> _callback) Gets a signed certificate from the configured Certificate Authority service.
okhttp3.Call	signCall(String account, String serviceId, String csr, String ttl, String accept, String xRequestId, ApiCallback _callback) Build call for sign
ApiResponse<CertificateJson>	signWithHttpInfo(String account, String serviceId, String csr, String ttl) Gets a signed certificate from the configured Certificate Authority service.
ApiResponse<CertificateJson>	signWithHttpInfo(String account, String serviceId, String csr, String ttl, String accept, String xRequestId) Gets a signed certificate from the configured Certificate Authority service.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateAuthorityApi

public CertificateAuthorityApi()

CertificateAuthorityApi

public CertificateAuthorityApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

signCall

public okhttp3.Call signCall(String account,
                             String serviceId,
                             String csr,
                             String ttl,
                             String accept,
                             String xRequestId,
                             ApiCallback _callback)
                      throws ApiException

Build call for sign

Parameters:

account - Organization account name (required)

serviceId - Name of the Certificate Authority service (required)

csr - (required)

ttl - (required)

accept - Setting the Accept header to `application/x-pem-file` allows Conjur to respond with a formatted certificate (optional)

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-

sign

public CertificateJson sign(String account,
                            String serviceId,
                            String csr,
                            String ttl,
                            String accept,
                            String xRequestId)
                     throws ApiException

Gets a signed certificate from the configured Certificate Authority service. Gets a signed certificate from the configured Certificate Authority service. The request must include a valid Certificate Signing Request, and a desired TTL in ISO 8601 format. *** IMPORTANT *** This endpoint is part of an early implementation of support for using Conjur as a certificate authority, and is currently available at the Community (or early alpha) level. This endpoint is still subject to breaking changes in the future.

Parameters:

account - Organization account name (required)

serviceId - Name of the Certificate Authority service (required)

csr - (required)

ttl - (required)

accept - Setting the Accept header to `application/x-pem-file` allows Conjur to respond with a formatted certificate (optional)

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:

CertificateJson

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-

sign

public CertificateJson sign(String account,
                            String serviceId,
                            String csr,
                            String ttl)
                     throws ApiException

Gets a signed certificate from the configured Certificate Authority service. Gets a signed certificate from the configured Certificate Authority service. The request must include a valid Certificate Signing Request, and a desired TTL in ISO 8601 format. *** IMPORTANT *** This endpoint is part of an early implementation of support for using Conjur as a certificate authority, and is currently available at the Community (or early alpha) level. This endpoint is still subject to breaking changes in the future.

Parameters:

account - Organization account name

serviceId - Name of the Certificate Authority service

csr -

ttl -

Returns:

CertificateJson

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-

signWithHttpInfo

public ApiResponse<CertificateJson> signWithHttpInfo(String account,
                                                     String serviceId,
                                                     String csr,
                                                     String ttl,
                                                     String accept,
                                                     String xRequestId)
                                              throws ApiException

Gets a signed certificate from the configured Certificate Authority service. Gets a signed certificate from the configured Certificate Authority service. The request must include a valid Certificate Signing Request, and a desired TTL in ISO 8601 format. *** IMPORTANT *** This endpoint is part of an early implementation of support for using Conjur as a certificate authority, and is currently available at the Community (or early alpha) level. This endpoint is still subject to breaking changes in the future.

Parameters:

account - Organization account name (required)

serviceId - Name of the Certificate Authority service (required)

csr - (required)

ttl - (required)

accept - Setting the Accept header to `application/x-pem-file` allows Conjur to respond with a formatted certificate (optional)

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<CertificateJson>

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-

signWithHttpInfo

public ApiResponse<CertificateJson> signWithHttpInfo(String account,
                                                     String serviceId,
                                                     String csr,
                                                     String ttl)
                                              throws ApiException

Gets a signed certificate from the configured Certificate Authority service. Gets a signed certificate from the configured Certificate Authority service. The request must include a valid Certificate Signing Request, and a desired TTL in ISO 8601 format. *** IMPORTANT *** This endpoint is part of an early implementation of support for using Conjur as a certificate authority, and is currently available at the Community (or early alpha) level. This endpoint is still subject to breaking changes in the future.

Parameters:

account - Organization account name

serviceId - Name of the Certificate Authority service

csr -

ttl -

Returns:

ApiResponse<CertificateJson>

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-

signAsync

public okhttp3.Call signAsync(String account,
                              String serviceId,
                              String csr,
                              String ttl,
                              String accept,
                              String xRequestId,
                              ApiCallback<CertificateJson> _callback)
                       throws ApiException

Gets a signed certificate from the configured Certificate Authority service. (asynchronously) Gets a signed certificate from the configured Certificate Authority service. The request must include a valid Certificate Signing Request, and a desired TTL in ISO 8601 format. *** IMPORTANT *** This endpoint is part of an early implementation of support for using Conjur as a certificate authority, and is currently available at the Community (or early alpha) level. This endpoint is still subject to breaking changes in the future.

Parameters:

account - Organization account name (required)

serviceId - Name of the Certificate Authority service (required)

csr - (required)

ttl - (required)

accept - Setting the Accept header to `application/x-pem-file` allows Conjur to respond with a formatted certificate (optional)

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
201	The response body is the newly signed certificate	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	Either - The authenticated role is not a Host role, - The authenticated Host does not have `sign` privilege for the CA service, or - The authenticated Host ID does not match the of the CSR Common Name (CN).	-
404	CA Service with the given ID does not exist	-