com.okta.sdk.resource.api.NetworkZoneApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation
Show all versions of okta-sdk-api Show documentation
The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta
API. This .jar is the only compile-time dependency within the Okta SDK project that your code should
depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.
/*
* Okta Admin Management
* Allows customers to easily access the Okta Management APIs
*
* The version of the OpenAPI document: 2024.08.3
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.okta.sdk.resource.api;
import com.fasterxml.jackson.core.type.TypeReference;
import com.okta.sdk.resource.client.ApiException;
import com.okta.sdk.resource.client.ApiClient;
import com.okta.sdk.resource.client.Configuration;
import com.okta.sdk.resource.model.*;
import com.okta.sdk.resource.client.Pair;
import com.okta.sdk.resource.model.Error;
import com.okta.sdk.resource.model.NetworkZone;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import org.openapitools.jackson.nullable.JsonNullableModule;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-11-15T08:48:47.130589-06:00[America/Chicago]", comments = "Generator version: 7.8.0")
public class NetworkZoneApi {
private ApiClient apiClient;
public NetworkZoneApi() {
this(Configuration.getDefaultApiClient());
}
public NetworkZoneApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Activate a Network Zone Activates a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone activateNetworkZone(String zoneId) throws ApiException {
return this.activateNetworkZone(zoneId, Collections.emptyMap());
}
/**
* Activate a Network Zone Activates a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone activateNetworkZone(String zoneId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'zoneId' is set
if (zoneId == null) {
throw new ApiException(400, "Missing the required parameter 'zoneId' when calling activateNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones/{zoneId}/lifecycle/activate".replaceAll("\\{" + "zoneId" + "\\}",
apiClient.escapeString(zoneId.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference localVarReturnType = new TypeReference() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* 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`.
*
* @param zone
* (required)
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone createNetworkZone(NetworkZone zone) throws ApiException {
return this.createNetworkZone(zone, Collections.emptyMap());
}
/**
* 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`.
*
* @param zone
* (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone createNetworkZone(NetworkZone zone, Map additionalHeaders) throws ApiException {
Object localVarPostBody = zone;
// verify the required parameter 'zone' is set
if (zone == null) {
throw new ApiException(400, "Missing the required parameter 'zone' when calling createNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = { "application/json" };
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference localVarReturnType = new TypeReference() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Deactivate a Network Zone Deactivates a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone deactivateNetworkZone(String zoneId) throws ApiException {
return this.deactivateNetworkZone(zoneId, Collections.emptyMap());
}
/**
* Deactivate a Network Zone Deactivates a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone deactivateNetworkZone(String zoneId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'zoneId' is set
if (zoneId == null) {
throw new ApiException(400, "Missing the required parameter 'zoneId' when calling deactivateNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones/{zoneId}/lifecycle/deactivate".replaceAll("\\{" + "zoneId" + "\\}",
apiClient.escapeString(zoneId.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference localVarReturnType = new TypeReference() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* 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>
*
* @param zoneId
* `id` of the Network Zone (required)
*
* @throws ApiException
* if fails to make API call
*/
public void deleteNetworkZone(String zoneId) throws ApiException {
this.deleteNetworkZone(zoneId, Collections.emptyMap());
}
/**
* 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>
*
* @param zoneId
* `id` of the Network Zone (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @throws ApiException
* if fails to make API call
*/
public void deleteNetworkZone(String zoneId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'zoneId' is set
if (zoneId == null) {
throw new ApiException(400, "Missing the required parameter 'zoneId' when calling deleteNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones/{zoneId}".replaceAll("\\{" + "zoneId" + "\\}",
apiClient.escapeString(zoneId.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
apiClient.invokeAPI(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* Retrieve a Network Zone Retrieves a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone getNetworkZone(String zoneId) throws ApiException {
return this.getNetworkZone(zoneId, Collections.emptyMap());
}
/**
* Retrieve a Network Zone Retrieves a Network Zone by `zoneId`
*
* @param zoneId
* `id` of the Network Zone (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone getNetworkZone(String zoneId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'zoneId' is set
if (zoneId == null) {
throw new ApiException(400, "Missing the required parameter 'zoneId' when calling getNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones/{zoneId}".replaceAll("\\{" + "zoneId" + "\\}",
apiClient.escapeString(zoneId.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference localVarReturnType = new TypeReference() {
};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* 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.
*
* @param after
* (optional)
* @param limit
* (optional, default to -1)
* @param filter
* (optional)
*
* @return List<NetworkZone>
*
* @throws ApiException
* if fails to make API call
*/
public List listNetworkZones(String after, Integer limit, String filter) throws ApiException {
return this.listNetworkZones(after, limit, filter, Collections.emptyMap());
}
/**
* 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.
*
* @param after
* (optional)
* @param limit
* (optional, default to -1)
* @param filter
* (optional)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return List<NetworkZone>
*
* @throws ApiException
* if fails to make API call
*/
public List listNetworkZones(String after, Integer limit, String filter,
Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/v1/zones";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("after", after));
localVarQueryParams.addAll(apiClient.parameterToPair("limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPair("filter", filter));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference> localVarReturnType = new TypeReference>() {
};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* 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.
*
* @param zoneId
* `id` of the Network Zone (required)
* @param zone
* (required)
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone replaceNetworkZone(String zoneId, NetworkZone zone) throws ApiException {
return this.replaceNetworkZone(zoneId, zone, Collections.emptyMap());
}
/**
* 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.
*
* @param zoneId
* `id` of the Network Zone (required)
* @param zone
* (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return NetworkZone
*
* @throws ApiException
* if fails to make API call
*/
public NetworkZone replaceNetworkZone(String zoneId, NetworkZone zone, Map additionalHeaders)
throws ApiException {
Object localVarPostBody = zone;
// verify the required parameter 'zoneId' is set
if (zoneId == null) {
throw new ApiException(400, "Missing the required parameter 'zoneId' when calling replaceNetworkZone");
}
// verify the required parameter 'zone' is set
if (zone == null) {
throw new ApiException(400, "Missing the required parameter 'zone' when calling replaceNetworkZone");
}
// create path and map variables
String localVarPath = "/api/v1/zones/{zoneId}".replaceAll("\\{" + "zoneId" + "\\}",
apiClient.escapeString(zoneId.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = { "application/json" };
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = { "application/json" };
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };
TypeReference localVarReturnType = new TypeReference() {
};
return apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
protected static ObjectMapper getObjectMapper() {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new JavaTimeModule());
objectMapper.registerModule(new JsonNullableModule());
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, true);
return objectMapper;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy