Skip to content

ApplicationFeaturesApi.md

Latest commit

 

History

History
256 lines (198 loc) · 8.68 KB

ApplicationFeaturesApi.md

File metadata and controls

256 lines (198 loc) · 8.68 KB

Okta.Sdk.Api.ApplicationFeaturesApi

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

Method HTTP request Description
GetFeatureForApplication GET /api/v1/apps/{appId}/features/{featureName} Retrieve a feature
ListFeaturesForApplication GET /api/v1/apps/{appId}/features List all features
UpdateFeatureForApplication PUT /api/v1/apps/{appId}/features/{featureName} Update a feature

GetFeatureForApplication

ApplicationFeature GetFeatureForApplication (string appId, ApplicationFeatureType featureName)

Retrieve a feature

Retrieves a Feature object for an app

Example

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

namespace Example
{
    public class GetFeatureForApplicationExample
    {
        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 ApplicationFeaturesApi(config);
            var appId = 0oafxqCAJWWGELFTYASJ;  // string | Application ID
            var featureName = (ApplicationFeatureType) "USER_PROVISIONING";  // ApplicationFeatureType | Name of the Feature

            try
            {
                // Retrieve a feature
                ApplicationFeature result = apiInstance.GetFeatureForApplication(appId, featureName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApplicationFeaturesApi.GetFeatureForApplication: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string Application ID
featureName ApplicationFeatureType Name of the Feature

Return type

ApplicationFeature

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]

ListFeaturesForApplication

List<ApplicationFeature> ListFeaturesForApplication (string appId)

List all features

Lists all features for an app > Note: This request returns an error if provisioning isn't enabled for the app. > To set up provisioning, see Update the default provisioning connection.

Example

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

namespace Example
{
    public class ListFeaturesForApplicationExample
    {
        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 ApplicationFeaturesApi(config);
            var appId = 0oafxqCAJWWGELFTYASJ;  // string | Application ID

            try
            {
                // List all features
                List<ApplicationFeature> result = apiInstance.ListFeaturesForApplication(appId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApplicationFeaturesApi.ListFeaturesForApplication: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string Application ID

Return type

List<ApplicationFeature>

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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

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

UpdateFeatureForApplication

ApplicationFeature UpdateFeatureForApplication (string appId, ApplicationFeatureType featureName, UpdateFeatureForApplicationRequest updateFeatureForApplicationRequest)

Update a feature

Updates a Feature object for an app > Note: This endpoint supports partial updates.

Example

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

namespace Example
{
    public class UpdateFeatureForApplicationExample
    {
        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 ApplicationFeaturesApi(config);
            var appId = 0oafxqCAJWWGELFTYASJ;  // string | Application ID
            var featureName = (ApplicationFeatureType) "USER_PROVISIONING";  // ApplicationFeatureType | Name of the Feature
            var updateFeatureForApplicationRequest = new UpdateFeatureForApplicationRequest(); // UpdateFeatureForApplicationRequest | 

            try
            {
                // Update a feature
                ApplicationFeature result = apiInstance.UpdateFeatureForApplication(appId, featureName, updateFeatureForApplicationRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApplicationFeaturesApi.UpdateFeatureForApplication: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string Application ID
featureName ApplicationFeatureType Name of the Feature
updateFeatureForApplicationRequest UpdateFeatureForApplicationRequest

Return type

ApplicationFeature

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

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

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