Class NetworkZoneApi

java.lang.Object
com.okta.sdk.resource.api.NetworkZoneApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class NetworkZoneApi extends Object
  • Constructor Details

    • NetworkZoneApi

      public NetworkZoneApi()
    • NetworkZoneApi

      public NetworkZoneApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • activateNetworkZone

      public NetworkZone activateNetworkZone(String zoneId) throws ApiException
      Activate a Network Zone Activates a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • activateNetworkZone

      public NetworkZone activateNetworkZone(String zoneId, Map<String,String> additionalHeaders) throws ApiException
      Activate a Network Zone Activates a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • createNetworkZone

      public NetworkZone createNetworkZone(NetworkZone zone) throws ApiException
      Create a Network Zone Creates a new network zone. * At least one of either the `gateways` attribute or `proxies` attribute must be defined when creating a Network Zone. * At least one of the following attributes must be defined: `proxyType`, `locations`, or `asns`.
      Parameters:
      zone - (required)
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • createNetworkZone

      public NetworkZone createNetworkZone(NetworkZone zone, Map<String,String> additionalHeaders) throws ApiException
      Create a Network Zone Creates a new network zone. * At least one of either the `gateways` attribute or `proxies` attribute must be defined when creating a Network Zone. * At least one of the following attributes must be defined: `proxyType`, `locations`, or `asns`.
      Parameters:
      zone - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • deactivateNetworkZone

      public NetworkZone deactivateNetworkZone(String zoneId) throws ApiException
      Deactivate a Network Zone Deactivates a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • deactivateNetworkZone

      public NetworkZone deactivateNetworkZone(String zoneId, Map<String,String> additionalHeaders) throws ApiException
      Deactivate a Network Zone Deactivates a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • deleteNetworkZone

      public void deleteNetworkZone(String zoneId) throws ApiException
      Delete a Network Zone Deletes network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      Throws:
      ApiException - if fails to make API call
    • deleteNetworkZone

      public void deleteNetworkZone(String zoneId, Map<String,String> additionalHeaders) throws ApiException
      Delete a Network Zone Deletes network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getNetworkZone

      public NetworkZone getNetworkZone(String zoneId) throws ApiException
      Retrieve a Network Zone Retrieves a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • getNetworkZone

      public NetworkZone getNetworkZone(String zoneId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Network Zone Retrieves a network zone by `zoneId`
      Parameters:
      zoneId - `id` of the Network Zone (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • listNetworkZones

      public List<NetworkZone> listNetworkZones(String after, Integer limit, String filter) throws ApiException
      List all Network Zones Lists all network zones with pagination. A subset of zones can be returned that match a supported filter expression or query. This operation requires URL encoding. For example, `filter=(id eq \"nzoul0wf9jyb8xwZm0g3\" or id eq \"nzoul1MxmGN18NDQT0g3\")` is encoded as `filter=%28id+eq+%22nzoul0wf9jyb8xwZm0g3%22+or+id+eq+%22nzoul1MxmGN18NDQT0g3%22%29`. Okta supports filtering on the `id` and `usage` properties. See [Filtering](https://developer.okta.com/docs/reference/core-okta-api/#filter) for more information on the expressions that are used in filtering.
      Parameters:
      after - Specifies the pagination cursor for the next page of network zones (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      filter - Filters zones by usage or ID expression (optional)
      Returns:
      List<NetworkZone>
      Throws:
      ApiException - if fails to make API call
    • listNetworkZones

      public List<NetworkZone> listNetworkZones(String after, Integer limit, String filter, Map<String,String> additionalHeaders) throws ApiException
      List all Network Zones Lists all network zones with pagination. A subset of zones can be returned that match a supported filter expression or query. This operation requires URL encoding. For example, `filter=(id eq \"nzoul0wf9jyb8xwZm0g3\" or id eq \"nzoul1MxmGN18NDQT0g3\")` is encoded as `filter=%28id+eq+%22nzoul0wf9jyb8xwZm0g3%22+or+id+eq+%22nzoul1MxmGN18NDQT0g3%22%29`. Okta supports filtering on the `id` and `usage` properties. See [Filtering](https://developer.okta.com/docs/reference/core-okta-api/#filter) for more information on the expressions that are used in filtering.
      Parameters:
      after - Specifies the pagination cursor for the next page of network zones (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      filter - Filters zones by usage or ID expression (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<NetworkZone>
      Throws:
      ApiException - if fails to make API call
    • replaceNetworkZone

      public NetworkZone replaceNetworkZone(String zoneId, NetworkZone zone) throws ApiException
      Replace a Network Zone Replaces a network zone by `zoneId`. The replaced network zone type must be the same as the existing type. You may replace the usage (`POLICY`, `BLOCKLIST`) of a network zone by updating the `usage` attribute.
      Parameters:
      zoneId - `id` of the Network Zone (required)
      zone - (required)
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • replaceNetworkZone

      public NetworkZone replaceNetworkZone(String zoneId, NetworkZone zone, Map<String,String> additionalHeaders) throws ApiException
      Replace a Network Zone Replaces a network zone by `zoneId`. The replaced network zone type must be the same as the existing type. You may replace the usage (`POLICY`, `BLOCKLIST`) of a network zone by updating the `usage` attribute.
      Parameters:
      zoneId - `id` of the Network Zone (required)
      zone - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      NetworkZone
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()