com.okta.sdk.resource.api.FeatureApi 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.Feature;
import com.okta.sdk.resource.model.FeatureLifecycle;
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 FeatureApi {
private ApiClient apiClient;
public FeatureApi() {
this(Configuration.getDefaultApiClient());
}
public FeatureApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Retrieve a Feature Retrieves a feature by ID
*
* @param featureId
* `id` of the feature (required)
*
* @return Feature
*
* @throws ApiException
* if fails to make API call
*/
public Feature getFeature(String featureId) throws ApiException {
return this.getFeature(featureId, Collections.emptyMap());
}
/**
* Retrieve a Feature Retrieves a feature by ID
*
* @param featureId
* `id` of the feature (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return Feature
*
* @throws ApiException
* if fails to make API call
*/
public Feature getFeature(String featureId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'featureId' is set
if (featureId == null) {
throw new ApiException(400, "Missing the required parameter 'featureId' when calling getFeature");
}
// create path and map variables
String localVarPath = "/api/v1/features/{featureId}".replaceAll("\\{" + "featureId" + "\\}",
apiClient.escapeString(featureId.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 dependencies Lists all feature dependencies for a specified feature. A feature's dependencies are
* the features that it requires to be enabled in order for itself to be enabled.
*
* @param featureId
* `id` of the feature (required)
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatureDependencies(String featureId) throws ApiException {
return this.listFeatureDependencies(featureId, Collections.emptyMap());
}
/**
* List all dependencies Lists all feature dependencies for a specified feature. A feature's dependencies are
* the features that it requires to be enabled in order for itself to be enabled.
*
* @param featureId
* `id` of the feature (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatureDependencies(String featureId, Map additionalHeaders)
throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'featureId' is set
if (featureId == null) {
throw new ApiException(400,
"Missing the required parameter 'featureId' when calling listFeatureDependencies");
}
// create path and map variables
String localVarPath = "/api/v1/features/{featureId}/dependencies".replaceAll("\\{" + "featureId" + "\\}",
apiClient.escapeString(featureId.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 dependents Lists all feature dependents for the specified feature. A feature's dependents are the
* features that need to be disabled in order for the feature itself to be disabled.
*
* @param featureId
* `id` of the feature (required)
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatureDependents(String featureId) throws ApiException {
return this.listFeatureDependents(featureId, Collections.emptyMap());
}
/**
* List all dependents Lists all feature dependents for the specified feature. A feature's dependents are the
* features that need to be disabled in order for the feature itself to be disabled.
*
* @param featureId
* `id` of the feature (required)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatureDependents(String featureId, Map additionalHeaders)
throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'featureId' is set
if (featureId == null) {
throw new ApiException(400,
"Missing the required parameter 'featureId' when calling listFeatureDependents");
}
// create path and map variables
String localVarPath = "/api/v1/features/{featureId}/dependents".replaceAll("\\{" + "featureId" + "\\}",
apiClient.escapeString(featureId.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 Features Lists all self-service features for your org
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatures() throws ApiException {
return this.listFeatures(Collections.emptyMap());
}
/**
* List all Features Lists all self-service features for your org
*
* @param additionalHeaders
* additionalHeaders for this call
*
* @return List<Feature>
*
* @throws ApiException
* if fails to make API call
*/
public List listFeatures(Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/v1/features";
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);
}
/**
* Update a Feature lifecycle Updates a feature's lifecycle status. Use this endpoint to enable or disable a
* feature for your org. Use the `mode=force` parameter to override dependency restrictions for a
* particular feature. Normally, you can't enable a feature if it has one or more dependencies that aren't
* enabled. When you use the `mode=force` parameter while enabling a feature, Okta first tries to
* enable any disabled features that this feature may have as dependencies. If you don't pass the
* `mode=force` parameter and the feature has dependencies that need to be enabled before the feature
* is enabled, a 400 error is returned. When you use the `mode=force` parameter while disabling a
* feature, Okta first tries to disable any enabled features that this feature may have as dependents. If you
* don't pass the `mode=force` parameter and the feature has dependents that need to be disabled
* before the feature is disabled, a 400 error is returned. The following chart shows the different state
* transitions for a feature. 
*
* @param featureId
* `id` of the feature (required)
* @param lifecycle
* Whether to `ENABLE` or `DISABLE` the feature (required)
* @param mode
* Indicates if you want to force enable or disable a feature. Supported value is `force`.
* (optional)
*
* @return Feature
*
* @throws ApiException
* if fails to make API call
*/
public Feature updateFeatureLifecycle(String featureId, FeatureLifecycle lifecycle, String mode)
throws ApiException {
return this.updateFeatureLifecycle(featureId, lifecycle, mode, Collections.emptyMap());
}
/**
* Update a Feature lifecycle Updates a feature's lifecycle status. Use this endpoint to enable or disable a
* feature for your org. Use the `mode=force` parameter to override dependency restrictions for a
* particular feature. Normally, you can't enable a feature if it has one or more dependencies that aren't
* enabled. When you use the `mode=force` parameter while enabling a feature, Okta first tries to
* enable any disabled features that this feature may have as dependencies. If you don't pass the
* `mode=force` parameter and the feature has dependencies that need to be enabled before the feature
* is enabled, a 400 error is returned. When you use the `mode=force` parameter while disabling a
* feature, Okta first tries to disable any enabled features that this feature may have as dependents. If you
* don't pass the `mode=force` parameter and the feature has dependents that need to be disabled
* before the feature is disabled, a 400 error is returned. The following chart shows the different state
* transitions for a feature. 
*
* @param featureId
* `id` of the feature (required)
* @param lifecycle
* Whether to `ENABLE` or `DISABLE` the feature (required)
* @param mode
* Indicates if you want to force enable or disable a feature. Supported value is `force`.
* (optional)
* @param additionalHeaders
* additionalHeaders for this call
*
* @return Feature
*
* @throws ApiException
* if fails to make API call
*/
public Feature updateFeatureLifecycle(String featureId, FeatureLifecycle lifecycle, String mode,
Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'featureId' is set
if (featureId == null) {
throw new ApiException(400,
"Missing the required parameter 'featureId' when calling updateFeatureLifecycle");
}
// verify the required parameter 'lifecycle' is set
if (lifecycle == null) {
throw new ApiException(400,
"Missing the required parameter 'lifecycle' when calling updateFeatureLifecycle");
}
// create path and map variables
String localVarPath = "/api/v1/features/{featureId}/{lifecycle}"
.replaceAll("\\{" + "featureId" + "\\}", apiClient.escapeString(featureId.toString()))
.replaceAll("\\{" + "lifecycle" + "\\}", apiClient.escapeString(lifecycle.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();
localVarQueryParams.addAll(apiClient.parameterToPair("mode", mode));
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);
}
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