Okta.Sdk.Api.FeatureApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
GetFeature	GET /api/v1/features/{featureId}	Retrieve a Feature
ListFeatureDependencies	GET /api/v1/features/{featureId}/dependencies	List all dependencies
ListFeatureDependents	GET /api/v1/features/{featureId}/dependents	List all dependents
ListFeatures	GET /api/v1/features	List all Features
UpdateFeatureLifecycle	POST /api/v1/features/{featureId}/{lifecycle}	Update a Feature lifecycle

GetFeature

Feature GetFeature (string featureId)

Retrieve a Feature

Retrieves a feature by ID

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetFeatureExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeatureApi(config);
            var featureId = R5HjqNn1pEqWGy48E9jg;  // string | `id` of the feature

            try
            {
                // Retrieve a Feature
                Feature result = apiInstance.GetFeature(featureId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling FeatureApi.GetFeature: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
featureId	string	`id` of the feature

Return type

Feature

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListFeatureDependencies

List<Feature> ListFeatureDependencies (string featureId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListFeatureDependenciesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeatureApi(config);
            var featureId = R5HjqNn1pEqWGy48E9jg;  // string | `id` of the feature

            try
            {
                // List all dependencies
                List<Feature> result = apiInstance.ListFeatureDependencies(featureId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling FeatureApi.ListFeatureDependencies: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
featureId	string	`id` of the feature

Return type

List<Feature>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListFeatureDependents

List<Feature> ListFeatureDependents (string featureId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListFeatureDependentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeatureApi(config);
            var featureId = R5HjqNn1pEqWGy48E9jg;  // string | `id` of the feature

            try
            {
                // List all dependents
                List<Feature> result = apiInstance.ListFeatureDependents(featureId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling FeatureApi.ListFeatureDependents: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
featureId	string	`id` of the feature

Return type

List<Feature>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListFeatures

List<Feature> ListFeatures ()

List all Features

Lists all self-service features for your org

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListFeaturesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeatureApi(config);

            try
            {
                // List all Features
                List<Feature> result = apiInstance.ListFeatures().ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling FeatureApi.ListFeatures: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<Feature>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateFeatureLifecycle

Feature UpdateFeatureLifecycle (string featureId, FeatureLifecycle lifecycle, string mode = null)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class UpdateFeatureLifecycleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeatureApi(config);
            var featureId = R5HjqNn1pEqWGy48E9jg;  // string | `id` of the feature
            var lifecycle = (FeatureLifecycle) "DISABLE";  // FeatureLifecycle | Whether to `ENABLE` or `DISABLE` the feature
            var mode = "mode_example";  // string | Indicates if you want to force enable or disable a feature. Supported value is `force`. (optional) 

            try
            {
                // Update a Feature lifecycle
                Feature result = apiInstance.UpdateFeatureLifecycle(featureId, lifecycle, mode);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling FeatureApi.UpdateFeatureLifecycle: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
featureId	string	`id` of the feature
lifecycle	FeatureLifecycle	Whether to `ENABLE` or `DISABLE` the feature
mode	string	Indicates if you want to force enable or disable a feature. Supported value is `force`.	[optional]

Return type

Feature

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FeatureApi.md

Latest commit

History

FeatureApi.md

File metadata and controls

Okta.Sdk.Api.FeatureApi

GetFeature

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListFeatureDependencies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListFeatureDependents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListFeatures

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateFeatureLifecycle

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details