Package com.okta.sdk.resource.api

Class NetworkZoneApi

java.lang.Object

com.okta.sdk.resource.api.NetworkZoneApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class NetworkZoneApi
extends Object

Constructor Summary

Constructors

Constructor	Description
NetworkZoneApi()
NetworkZoneApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
NetworkZone	activateNetworkZone(String zoneId)	Activate a Network Zone Activates a Network Zone by `zoneId`
NetworkZone	activateNetworkZone(String zoneId, Map<String,String> additionalHeaders)	Activate a Network Zone Activates a Network Zone by `zoneId`
NetworkZone	createNetworkZone(NetworkZone zone)	Create a Network Zone Creates a Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`.
NetworkZone	createNetworkZone(NetworkZone zone, Map<String,String> additionalHeaders)	Create a Network Zone Creates a Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`.
NetworkZone	deactivateNetworkZone(String zoneId)	Deactivate a Network Zone Deactivates a Network Zone by `zoneId`
NetworkZone	deactivateNetworkZone(String zoneId, Map<String,String> additionalHeaders)	Deactivate a Network Zone Deactivates a Network Zone by `zoneId`
void	deleteNetworkZone(String zoneId)	Delete a Network Zone Deletes a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules).
void	deleteNetworkZone(String zoneId, Map<String,String> additionalHeaders)	Delete a Network Zone Deletes a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules).
ApiClient	getApiClient()
NetworkZone	getNetworkZone(String zoneId)	Retrieve a Network Zone Retrieves a Network Zone by `zoneId`
NetworkZone	getNetworkZone(String zoneId, Map<String,String> additionalHeaders)	Retrieve a Network Zone Retrieves a Network Zone by `zoneId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<NetworkZone>	listNetworkZones(String after, Integer limit, String filter)	List all Network Zones Lists all Network Zones with pagination.
List<NetworkZone>	listNetworkZones(String after, Integer limit, String filter, Map<String,String> additionalHeaders)	List all Network Zones Lists all Network Zones with pagination.
NetworkZone	replaceNetworkZone(String zoneId, NetworkZone zone)	Replace a Network Zone Replaces a Network Zone by `zoneId`.
NetworkZone	replaceNetworkZone(String zoneId, NetworkZone zone, Map<String,String> additionalHeaders)	Replace a Network Zone Replaces a Network Zone by `zoneId`.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

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 Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`. * For a Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `proxyType`. * For an Enhanced Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `ipServiceCategories`.

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 Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`. * For a Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `proxyType`. * For an Enhanced Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `ipServiceCategories`.

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 a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules). > * For Okta Identity Engine orgs, you can't delete a Network Zone with an ACTIVE `status`. <x-lifecycle class=\"oie\"></x-lifecycle>

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 a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules). > * For Okta Identity Engine orgs, you can't delete a Network Zone with an ACTIVE `status`. <x-lifecycle class=\"oie\"></x-lifecycle>

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 - (optional)

limit - (optional, default to -1)

filter - (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 - (optional)

limit - (optional, default to -1)

filter - (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 can 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 can 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()