Package com.okta.sdk.resource.api
Class FeatureApi
java.lang.Object
com.okta.sdk.resource.api.FeatureApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
comments="Generator version: 7.8.0")
public class FeatureApi
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetFeature
(String featureId) Retrieve a Feature Retrieves a feature by IDgetFeature
(String featureId, Map<String, String> additionalHeaders) Retrieve a Feature Retrieves a feature by IDprotected static com.fasterxml.jackson.databind.ObjectMapper
listFeatureDependencies
(String featureId) List all dependencies Lists all feature dependencies for a specified feature.listFeatureDependencies
(String featureId, Map<String, String> additionalHeaders) List all dependencies Lists all feature dependencies for a specified feature.listFeatureDependents
(String featureId) List all dependents Lists all feature dependents for the specified feature.listFeatureDependents
(String featureId, Map<String, String> additionalHeaders) List all dependents Lists all feature dependents for the specified feature.List all Features Lists all self-service features for your orglistFeatures
(Map<String, String> additionalHeaders) List all Features Lists all self-service features for your orgvoid
setApiClient
(ApiClient apiClient) updateFeatureLifecycle
(String featureId, FeatureLifecycle lifecycle, String mode) Update a Feature lifecycle Updates a feature's lifecycle status.updateFeatureLifecycle
(String featureId, FeatureLifecycle lifecycle, String mode, Map<String, String> additionalHeaders) Update a Feature lifecycle Updates a feature's lifecycle status.
-
Constructor Details
-
FeatureApi
public FeatureApi() -
FeatureApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getFeature
Retrieve a Feature Retrieves a feature by ID- Parameters:
featureId
- `id` of the feature (required)- Returns:
- Feature
- Throws:
ApiException
- if fails to make API call
-
getFeature
public Feature getFeature(String featureId, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Feature Retrieves a feature by ID- Parameters:
featureId
- `id` of the feature (required)additionalHeaders
- additionalHeaders for this call- Returns:
- Feature
- Throws:
ApiException
- if fails to make API call
-
listFeatureDependencies
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.- Parameters:
featureId
- `id` of the feature (required)- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
listFeatureDependencies
public List<Feature> listFeatureDependencies(String featureId, Map<String, String> additionalHeaders) throws ApiExceptionList 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.- Parameters:
featureId
- `id` of the feature (required)additionalHeaders
- additionalHeaders for this call- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
listFeatureDependents
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.- Parameters:
featureId
- `id` of the feature (required)- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
listFeatureDependents
public List<Feature> listFeatureDependents(String featureId, Map<String, String> additionalHeaders) throws ApiExceptionList 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.- Parameters:
featureId
- `id` of the feature (required)additionalHeaders
- additionalHeaders for this call- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
listFeatures
List all Features Lists all self-service features for your org- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
listFeatures
List all Features Lists all self-service features for your org- Parameters:
additionalHeaders
- additionalHeaders for this call- Returns:
- List<Feature>
- Throws:
ApiException
- if fails to make API call
-
updateFeatureLifecycle
public Feature updateFeatureLifecycle(String featureId, FeatureLifecycle lifecycle, String mode) throws ApiException 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. ![State transitions of a feature](../../../../../images/features/update-ssfeat-flowchart.png '#width=500px;')- Parameters:
featureId
- `id` of the feature (required)lifecycle
- Whether to `ENABLE` or `DISABLE` the feature (required)mode
- Indicates if you want to force enable or disable a feature. Supported value is `force`. (optional)- Returns:
- Feature
- Throws:
ApiException
- if fails to make API call
-
updateFeatureLifecycle
public Feature updateFeatureLifecycle(String featureId, FeatureLifecycle lifecycle, String mode, Map<String, String> additionalHeaders) throws ApiExceptionUpdate 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. ![State transitions of a feature](../../../../../images/features/update-ssfeat-flowchart.png '#width=500px;')- Parameters:
featureId
- `id` of the feature (required)lifecycle
- Whether to `ENABLE` or `DISABLE` the feature (required)mode
- Indicates if you want to force enable or disable a feature. Supported value is `force`. (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- Feature
- Throws:
ApiException
- if fails to make API call
-
getObjectMapper
protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
-