com.cyberark.conjur.sdk.endpoint

Class PoliciesApi

java.lang.Object

com.cyberark.conjur.sdk.endpoint.PoliciesApi

public class PoliciesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PoliciesApi()
PoliciesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
LoadedPolicy	loadPolicy(String account, String identifier, String body) Adds data to the existing Conjur policy.
LoadedPolicy	loadPolicy(String account, String identifier, String body, String xRequestId) Adds data to the existing Conjur policy.
okhttp3.Call	loadPolicyAsync(String account, String identifier, String body, String xRequestId, ApiCallback<LoadedPolicy> _callback) Adds data to the existing Conjur policy.
okhttp3.Call	loadPolicyCall(String account, String identifier, String body, String xRequestId, ApiCallback _callback) Build call for loadPolicy
ApiResponse<LoadedPolicy>	loadPolicyWithHttpInfo(String account, String identifier, String body) Adds data to the existing Conjur policy.
ApiResponse<LoadedPolicy>	loadPolicyWithHttpInfo(String account, String identifier, String body, String xRequestId) Adds data to the existing Conjur policy.
LoadedPolicy	replacePolicy(String account, String identifier, String body) Loads or replaces a Conjur policy document.
LoadedPolicy	replacePolicy(String account, String identifier, String body, String xRequestId) Loads or replaces a Conjur policy document.
okhttp3.Call	replacePolicyAsync(String account, String identifier, String body, String xRequestId, ApiCallback<LoadedPolicy> _callback) Loads or replaces a Conjur policy document.
okhttp3.Call	replacePolicyCall(String account, String identifier, String body, String xRequestId, ApiCallback _callback) Build call for replacePolicy
ApiResponse<LoadedPolicy>	replacePolicyWithHttpInfo(String account, String identifier, String body) Loads or replaces a Conjur policy document.
ApiResponse<LoadedPolicy>	replacePolicyWithHttpInfo(String account, String identifier, String body, String xRequestId) Loads or replaces a Conjur policy document.
void	setApiClient(ApiClient apiClient)
LoadedPolicy	updatePolicy(String account, String identifier, String body) Modifies an existing Conjur policy.
LoadedPolicy	updatePolicy(String account, String identifier, String body, String xRequestId) Modifies an existing Conjur policy.
okhttp3.Call	updatePolicyAsync(String account, String identifier, String body, String xRequestId, ApiCallback<LoadedPolicy> _callback) Modifies an existing Conjur policy.
okhttp3.Call	updatePolicyCall(String account, String identifier, String body, String xRequestId, ApiCallback _callback) Build call for updatePolicy
ApiResponse<LoadedPolicy>	updatePolicyWithHttpInfo(String account, String identifier, String body) Modifies an existing Conjur policy.
ApiResponse<LoadedPolicy>	updatePolicyWithHttpInfo(String account, String identifier, String body, String xRequestId) Modifies an existing Conjur policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoliciesApi

public PoliciesApi()

PoliciesApi

public PoliciesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

loadPolicyCall

public okhttp3.Call loadPolicyCall(String account,
                                   String identifier,
                                   String body,
                                   String xRequestId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for loadPolicy

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

loadPolicy

public LoadedPolicy loadPolicy(String account,
                               String identifier,
                               String body,
                               String xRequestId)
                        throws ApiException

Adds data to the existing Conjur policy. Adds data to the existing Conjur policy. Deletions are not allowed. Any policy objects that exist on the server but are omitted from the policy file will not be deleted and any explicit deletions in the policy file will result in an error. ##### Permissions required `create` privilege on the policy.\"

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

loadPolicy

public LoadedPolicy loadPolicy(String account,
                               String identifier,
                               String body)
                        throws ApiException

Adds data to the existing Conjur policy. Adds data to the existing Conjur policy. Deletions are not allowed. Any policy objects that exist on the server but are omitted from the policy file will not be deleted and any explicit deletions in the policy file will result in an error. ##### Permissions required `create` privilege on the policy.\"

Parameters:

account - Organization account name

identifier - ID of the policy to update

body - Policy

Returns:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

loadPolicyWithHttpInfo

public ApiResponse<LoadedPolicy> loadPolicyWithHttpInfo(String account,
                                                        String identifier,
                                                        String body,
                                                        String xRequestId)
                                                 throws ApiException

Adds data to the existing Conjur policy. Adds data to the existing Conjur policy. Deletions are not allowed. Any policy objects that exist on the server but are omitted from the policy file will not be deleted and any explicit deletions in the policy file will result in an error. ##### Permissions required `create` privilege on the policy.\"

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

loadPolicyWithHttpInfo

public ApiResponse<LoadedPolicy> loadPolicyWithHttpInfo(String account,
                                                        String identifier,
                                                        String body)
                                                 throws ApiException

Adds data to the existing Conjur policy. Adds data to the existing Conjur policy. Deletions are not allowed. Any policy objects that exist on the server but are omitted from the policy file will not be deleted and any explicit deletions in the policy file will result in an error. ##### Permissions required `create` privilege on the policy.\"

Parameters:

account - Organization account name

identifier - ID of the policy to update

body - Policy

Returns:

ApiResponse<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

loadPolicyAsync

public okhttp3.Call loadPolicyAsync(String account,
                                    String identifier,
                                    String body,
                                    String xRequestId,
                                    ApiCallback<LoadedPolicy> _callback)
                             throws ApiException

Adds data to the existing Conjur policy. (asynchronously) Adds data to the existing Conjur policy. Deletions are not allowed. Any policy objects that exist on the server but are omitted from the policy file will not be deleted and any explicit deletions in the policy file will result in an error. ##### Permissions required `create` privilege on the policy.\"

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicyCall

public okhttp3.Call replacePolicyCall(String account,
                                      String identifier,
                                      String body,
                                      String xRequestId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for replacePolicy

Parameters:

account - Organization account name (required)

identifier - ID of the policy to load (root if no root policy has been loaded yet) (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicy

public LoadedPolicy replacePolicy(String account,
                                  String identifier,
                                  String body,
                                  String xRequestId)
                           throws ApiException

Loads or replaces a Conjur policy document. Loads or replaces a Conjur policy document. **Any policy data which already exists on the server but is not explicitly specified in the new policy file will be deleted!**.

Parameters:

account - Organization account name (required)

identifier - ID of the policy to load (root if no root policy has been loaded yet) (required)

body - Policy (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:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicy

public LoadedPolicy replacePolicy(String account,
                                  String identifier,
                                  String body)
                           throws ApiException

Loads or replaces a Conjur policy document. Loads or replaces a Conjur policy document. **Any policy data which already exists on the server but is not explicitly specified in the new policy file will be deleted!**.

Parameters:

account - Organization account name

identifier - ID of the policy to load (root if no root policy has been loaded yet)

body - Policy

Returns:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicyWithHttpInfo

public ApiResponse<LoadedPolicy> replacePolicyWithHttpInfo(String account,
                                                           String identifier,
                                                           String body,
                                                           String xRequestId)
                                                    throws ApiException

Loads or replaces a Conjur policy document. Loads or replaces a Conjur policy document. **Any policy data which already exists on the server but is not explicitly specified in the new policy file will be deleted!**.

Parameters:

account - Organization account name (required)

identifier - ID of the policy to load (root if no root policy has been loaded yet) (required)

body - Policy (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<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicyWithHttpInfo

public ApiResponse<LoadedPolicy> replacePolicyWithHttpInfo(String account,
                                                           String identifier,
                                                           String body)
                                                    throws ApiException

Loads or replaces a Conjur policy document. Loads or replaces a Conjur policy document. **Any policy data which already exists on the server but is not explicitly specified in the new policy file will be deleted!**.

Parameters:

account - Organization account name

identifier - ID of the policy to load (root if no root policy has been loaded yet)

body - Policy

Returns:

ApiResponse<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

replacePolicyAsync

public okhttp3.Call replacePolicyAsync(String account,
                                       String identifier,
                                       String body,
                                       String xRequestId,
                                       ApiCallback<LoadedPolicy> _callback)
                                throws ApiException

Loads or replaces a Conjur policy document. (asynchronously) Loads or replaces a Conjur policy document. **Any policy data which already exists on the server but is not explicitly specified in the new policy file will be deleted!**.

Parameters:

account - Organization account name (required)

identifier - ID of the policy to load (root if no root policy has been loaded yet) (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicyCall

public okhttp3.Call updatePolicyCall(String account,
                                     String identifier,
                                     String body,
                                     String xRequestId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for updatePolicy

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicy

public LoadedPolicy updatePolicy(String account,
                                 String identifier,
                                 String body,
                                 String xRequestId)
                          throws ApiException

Modifies an existing Conjur policy. Modifies an existing Conjur policy. Data may be explicitly deleted using the `!delete`, `!revoke`, and `!deny` statements. Unlike `replace` mode, no data is ever implicitly deleted. ##### Permissions required

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicy

public LoadedPolicy updatePolicy(String account,
                                 String identifier,
                                 String body)
                          throws ApiException

Modifies an existing Conjur policy. Modifies an existing Conjur policy. Data may be explicitly deleted using the `!delete`, `!revoke`, and `!deny` statements. Unlike `replace` mode, no data is ever implicitly deleted. ##### Permissions required

Parameters:

account - Organization account name

identifier - ID of the policy to update

body - Policy

Returns:

LoadedPolicy

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicyWithHttpInfo

public ApiResponse<LoadedPolicy> updatePolicyWithHttpInfo(String account,
                                                          String identifier,
                                                          String body,
                                                          String xRequestId)
                                                   throws ApiException

Modifies an existing Conjur policy. Modifies an existing Conjur policy. Data may be explicitly deleted using the `!delete`, `!revoke`, and `!deny` statements. Unlike `replace` mode, no data is ever implicitly deleted. ##### Permissions required

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicyWithHttpInfo

public ApiResponse<LoadedPolicy> updatePolicyWithHttpInfo(String account,
                                                          String identifier,
                                                          String body)
                                                   throws ApiException

Modifies an existing Conjur policy. Modifies an existing Conjur policy. Data may be explicitly deleted using the `!delete`, `!revoke`, and `!deny` statements. Unlike `replace` mode, no data is ever implicitly deleted. ##### Permissions required

Parameters:

account - Organization account name

identifier - ID of the policy to update

body - Policy

Returns:

ApiResponse<LoadedPolicy>

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	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-

updatePolicyAsync

public okhttp3.Call updatePolicyAsync(String account,
                                      String identifier,
                                      String body,
                                      String xRequestId,
                                      ApiCallback<LoadedPolicy> _callback)
                               throws ApiException

Modifies an existing Conjur policy. (asynchronously) Modifies an existing Conjur policy. Data may be explicitly deleted using the `!delete`, `!revoke`, and `!deny` statements. Unlike `replace` mode, no data is ever implicitly deleted. ##### Permissions required

Parameters:

account - Organization account name (required)

identifier - ID of the policy to update (required)

body - Policy (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
201	Decsribes new data created by a successful policy load	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
403	The authenticated user lacks the necessary privileges	-
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	-
409	Similar operation already in progress, retry after a delay	-
422	A request parameter was either missing or invalid.	-