Package com.cyberark.conjur.sdk.endpoint

Class StatusApi

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

  • Constructor Details

    • StatusApi

      public StatusApi()

    • StatusApi

      public StatusApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getAuthenticatorsCall

      public okhttp3.Call getAuthenticatorsCall(String xRequestId, ApiCallback _callback) throws ApiException
      Build call for getAuthenticators
      Parameters:
      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 Details about authenticators for this Conjur server -

    • getAuthenticators

      public AuthenticatorsResponse getAuthenticators(String xRequestId) throws ApiException
      Details about which authenticators are on the Conjur Server Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication
      Parameters:
      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:
      AuthenticatorsResponse
      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 Details about authenticators for this Conjur server -

    • getAuthenticators

      public AuthenticatorsResponse getAuthenticators() throws ApiException
      Details about which authenticators are on the Conjur Server Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication
      Returns:
      AuthenticatorsResponse
      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 Details about authenticators for this Conjur server -

    • getAuthenticatorsWithHttpInfo

      public ApiResponse<AuthenticatorsResponse> getAuthenticatorsWithHttpInfo(String xRequestId) throws ApiException
      Details about which authenticators are on the Conjur Server Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication
      Parameters:
      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<AuthenticatorsResponse>
      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 Details about authenticators for this Conjur server -

    • getAuthenticatorsWithHttpInfo

      public ApiResponse<AuthenticatorsResponse> getAuthenticatorsWithHttpInfo() throws ApiException
      Details about which authenticators are on the Conjur Server Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication
      Returns:
      ApiResponse<AuthenticatorsResponse>
      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 Details about authenticators for this Conjur server -

    • getAuthenticatorsAsync

      public okhttp3.Call getAuthenticatorsAsync(String xRequestId, ApiCallback<AuthenticatorsResponse> _callback) throws ApiException
      Details about which authenticators are on the Conjur Server (asynchronously) Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication
      Parameters:
      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 Details about authenticators for this Conjur server -

    • getGCPAuthenticatorStatusCall

      public okhttp3.Call getGCPAuthenticatorStatusCall(String account, String xRequestId, ApiCallback _callback) throws ApiException
      Build call for getGCPAuthenticatorStatus
      Parameters:
      account - The organization account name (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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getGCPAuthenticatorStatus

      public AuthenticatorStatus getGCPAuthenticatorStatus(String account, String xRequestId) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. This operation only supports the GCP authenticator See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      account - The organization account name (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:
      AuthenticatorStatus
      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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getGCPAuthenticatorStatus

      public AuthenticatorStatus getGCPAuthenticatorStatus(String account) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. This operation only supports the GCP authenticator See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      account - The organization account name
      Returns:
      AuthenticatorStatus
      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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getGCPAuthenticatorStatusWithHttpInfo

      public ApiResponse<AuthenticatorStatus> getGCPAuthenticatorStatusWithHttpInfo(String account, String xRequestId) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. This operation only supports the GCP authenticator See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      account - The organization account name (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<AuthenticatorStatus>
      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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getGCPAuthenticatorStatusWithHttpInfo

      public ApiResponse<AuthenticatorStatus> getGCPAuthenticatorStatusWithHttpInfo(String account) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. This operation only supports the GCP authenticator See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      account - The organization account name
      Returns:
      ApiResponse<AuthenticatorStatus>
      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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getGCPAuthenticatorStatusAsync

      public okhttp3.Call getGCPAuthenticatorStatusAsync(String account, String xRequestId, ApiCallback<AuthenticatorStatus> _callback) throws ApiException
      Details whether an authentication service has been configured properly (asynchronously) Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. This operation only supports the GCP authenticator See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      account - The organization account name (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 The response contains info about the result -
      400 The server cannot process the request due to malformed request syntax -
      403 The authenticated user lacks the necessary privileges -
      404 The service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatusCall

      public okhttp3.Call getServiceAuthenticatorStatusCall(String authenticator, String serviceId, String account, String xRequestId, ApiCallback _callback) throws ApiException
      Build call for getServiceAuthenticatorStatus
      Parameters:
      authenticator - The type of authenticator (required)
      serviceId - URL-Encoded authenticator service ID (required)
      account - The organization account name (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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatus

      public AuthenticatorStatus getServiceAuthenticatorStatus(String authenticator, String serviceId, String account, String xRequestId) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. Supported Authenticators: - Azure - OIDC Not Supported: - AWS IAM - Kubernetes - LDAP See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      authenticator - The type of authenticator (required)
      serviceId - URL-Encoded authenticator service ID (required)
      account - The organization account name (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:
      AuthenticatorStatus
      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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatus

      public AuthenticatorStatus getServiceAuthenticatorStatus(String authenticator, String serviceId, String account) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. Supported Authenticators: - Azure - OIDC Not Supported: - AWS IAM - Kubernetes - LDAP See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      authenticator - The type of authenticator
      serviceId - URL-Encoded authenticator service ID
      account - The organization account name
      Returns:
      AuthenticatorStatus
      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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatusWithHttpInfo

      public ApiResponse<AuthenticatorStatus> getServiceAuthenticatorStatusWithHttpInfo(String authenticator, String serviceId, String account, String xRequestId) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. Supported Authenticators: - Azure - OIDC Not Supported: - AWS IAM - Kubernetes - LDAP See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      authenticator - The type of authenticator (required)
      serviceId - URL-Encoded authenticator service ID (required)
      account - The organization account name (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<AuthenticatorStatus>
      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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatusWithHttpInfo

      public ApiResponse<AuthenticatorStatus> getServiceAuthenticatorStatusWithHttpInfo(String authenticator, String serviceId, String account) throws ApiException
      Details whether an authentication service has been configured properly Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. Supported Authenticators: - Azure - OIDC Not Supported: - AWS IAM - Kubernetes - LDAP See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      authenticator - The type of authenticator
      serviceId - URL-Encoded authenticator service ID
      account - The organization account name
      Returns:
      ApiResponse<AuthenticatorStatus>
      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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • getServiceAuthenticatorStatusAsync

      public okhttp3.Call getServiceAuthenticatorStatusAsync(String authenticator, String serviceId, String account, String xRequestId, ApiCallback<AuthenticatorStatus> _callback) throws ApiException
      Details whether an authentication service has been configured properly (asynchronously) Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator. Supported Authenticators: - Azure - OIDC Not Supported: - AWS IAM - Kubernetes - LDAP See [Conjur Documentation](https://docs.conjur.org/Latest/en/Content/Integrations/Authn-status.htm) for details on setting up the authenticator status webservice.
      Parameters:
      authenticator - The type of authenticator (required)
      serviceId - URL-Encoded authenticator service ID (required)
      account - The organization account name (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 The response contains info about the result -
      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 service was not found -
      500 The response contains info about the result -
      501 The response contains info about the result -

    • whoAmICall

      public okhttp3.Call whoAmICall(String xRequestId, ApiCallback _callback) throws ApiException
      Build call for whoAmI
      Parameters:
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -

    • whoAmI

      public WhoAmI whoAmI(String xRequestId) throws ApiException
      Provides information about the client making an API request. WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
      Parameters:
      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:
      WhoAmI
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -

    • whoAmI

      public WhoAmI whoAmI() throws ApiException
      Provides information about the client making an API request. WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
      Returns:
      WhoAmI
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -

    • whoAmIWithHttpInfo

      public ApiResponse<WhoAmI> whoAmIWithHttpInfo(String xRequestId) throws ApiException
      Provides information about the client making an API request. WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
      Parameters:
      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<WhoAmI>
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -

    • whoAmIWithHttpInfo

      public ApiResponse<WhoAmI> whoAmIWithHttpInfo() throws ApiException
      Provides information about the client making an API request. WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
      Returns:
      ApiResponse<WhoAmI>
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -

    • whoAmIAsync

      public okhttp3.Call whoAmIAsync(String xRequestId, ApiCallback<WhoAmI> _callback) throws ApiException
      Provides information about the client making an API request. (asynchronously) WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
      Parameters:
      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 Details about the client making the request -
      401 Authentication information is missing or invalid -