Package com.cyberark.conjur.sdk.endpoint

Class HostFactoryApi

java.lang.Object
com.cyberark.conjur.sdk.endpoint.HostFactoryApi
public class HostFactoryApi extends Object

  • Constructor Details

    • HostFactoryApi

      public HostFactoryApi()

    • HostFactoryApi

      public HostFactoryApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createHostCall

      public okhttp3.Call createHostCall(String id, String xRequestId, Object annotations, ApiCallback _callback) throws ApiException
      Build call for createHost
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory. (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)
      annotations - Annotations to apply to the new host (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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createHost

      public CreateHost createHost(String id, String xRequestId, Object annotations) throws ApiException
      Creates a Host using the Host Factory. Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory. (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)
      annotations - Annotations to apply to the new host (optional)
      Returns:
      CreateHost
      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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createHost

      public CreateHost createHost(String id) throws ApiException
      Creates a Host using the Host Factory. Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory.
      Returns:
      CreateHost
      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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createHostWithHttpInfo

      public ApiResponse<CreateHost> createHostWithHttpInfo(String id, String xRequestId, Object annotations) throws ApiException
      Creates a Host using the Host Factory. Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory. (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)
      annotations - Annotations to apply to the new host (optional)
      Returns:
      ApiResponse<CreateHost>
      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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createHostWithHttpInfo

      public ApiResponse<CreateHost> createHostWithHttpInfo(String id) throws ApiException
      Creates a Host using the Host Factory. Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory.
      Returns:
      ApiResponse<CreateHost>
      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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createHostAsync

      public okhttp3.Call createHostAsync(String id, String xRequestId, Object annotations, ApiCallback<CreateHost> _callback) throws ApiException
      Creates a Host using the Host Factory. (asynchronously) Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.
      Parameters:
      id - Identifier of the host to be created. It will be created within the account of the host factory. (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)
      annotations - Annotations to apply to the new host (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 contains the newly-created host -
      401 Authentication information is missing or invalid -
      422 A request parameter was either missing or invalid. -

    • createTokenCall

      public okhttp3.Call createTokenCall(String expiration, String hostFactory, String xRequestId, List<String> cidr, Integer count, ApiCallback _callback) throws ApiException
      Build call for createToken
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time. (required)
      hostFactory - Fully qualified host factory ID (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)
      cidr - Number of host tokens to create (optional)
      count - Number of host tokens to create (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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • createToken

      public List<Object> createToken(String expiration, String hostFactory, String xRequestId, List<String> cidr, Integer count) throws ApiException
      Creates one or more host identity tokens. Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # `execute` privilege on the Host Factory.\"
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time. (required)
      hostFactory - Fully qualified host factory ID (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)
      cidr - Number of host tokens to create (optional)
      count - Number of host tokens to create (optional)
      Returns:
      List<Object>
      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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • createToken

      public List<Object> createToken(String expiration, String hostFactory) throws ApiException
      Creates one or more host identity tokens. Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # `execute` privilege on the Host Factory.\"
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time.
      hostFactory - Fully qualified host factory ID
      Returns:
      List<Object>
      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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • createTokenWithHttpInfo

      public ApiResponse<List<Object>> createTokenWithHttpInfo(String expiration, String hostFactory, String xRequestId, List<String> cidr, Integer count) throws ApiException
      Creates one or more host identity tokens. Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # `execute` privilege on the Host Factory.\"
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time. (required)
      hostFactory - Fully qualified host factory ID (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)
      cidr - Number of host tokens to create (optional)
      count - Number of host tokens to create (optional)
      Returns:
      ApiResponse<List<Object>>
      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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • createTokenWithHttpInfo

      public ApiResponse<List<Object>> createTokenWithHttpInfo(String expiration, String hostFactory) throws ApiException
      Creates one or more host identity tokens. Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # `execute` privilege on the Host Factory.\"
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time.
      hostFactory - Fully qualified host factory ID
      Returns:
      ApiResponse<List<Object>>
      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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • createTokenAsync

      public okhttp3.Call createTokenAsync(String expiration, String hostFactory, String xRequestId, List<String> cidr, Integer count, ApiCallback<List<Object>> _callback) throws ApiException
      Creates one or more host identity tokens. (asynchronously) Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # `execute` privilege on the Host Factory.\"
      Parameters:
      expiration - `ISO 8601 datetime` denoting a requested expiration time. (required)
      hostFactory - Fully qualified host factory ID (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)
      cidr - Number of host tokens to create (optional)
      count - Number of host tokens to create (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 Zero or more tokens were created and delivered in the response body -
      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 -
      422 A request parameter was either missing or invalid. -

    • revokeTokenCall

      public okhttp3.Call revokeTokenCall(String token, String xRequestId, ApiCallback _callback) throws ApiException
      Build call for revokeToken
      Parameters:
      token - The host factory token to revoke (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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -

    • revokeToken

      public void revokeToken(String token, String xRequestId) throws ApiException
      Revokes a token, immediately disabling it. Revokes a token, immediately disabling it. ##### Permissions required `update` privilege on the host factory.\"
      Parameters:
      token - The host factory token to revoke (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)
      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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -

    • revokeToken

      public void revokeToken(String token) throws ApiException
      Revokes a token, immediately disabling it. Revokes a token, immediately disabling it. ##### Permissions required `update` privilege on the host factory.\"
      Parameters:
      token - The host factory token to revoke
      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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -

    • revokeTokenWithHttpInfo

      public ApiResponse<Void> revokeTokenWithHttpInfo(String token, String xRequestId) throws ApiException
      Revokes a token, immediately disabling it. Revokes a token, immediately disabling it. ##### Permissions required `update` privilege on the host factory.\"
      Parameters:
      token - The host factory token to revoke (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<Void>
      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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -

    • revokeTokenWithHttpInfo

      public ApiResponse<Void> revokeTokenWithHttpInfo(String token) throws ApiException
      Revokes a token, immediately disabling it. Revokes a token, immediately disabling it. ##### Permissions required `update` privilege on the host factory.\"
      Parameters:
      token - The host factory token to revoke
      Returns:
      ApiResponse<Void>
      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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -

    • revokeTokenAsync

      public okhttp3.Call revokeTokenAsync(String token, String xRequestId, ApiCallback<Void> _callback) throws ApiException
      Revokes a token, immediately disabling it. (asynchronously) Revokes a token, immediately disabling it. ##### Permissions required `update` privilege on the host factory.\"
      Parameters:
      token - The host factory token to revoke (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
      204 Token was successfully revoked -
      400 The server cannot process the request due to malformed request syntax -
      401 Authentication information is missing or invalid -
      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 -