Skip to content

Latest commit

 

History

History
169 lines (129 loc) · 5.78 KB

OktaApplicationSettingsApi.md

File metadata and controls

169 lines (129 loc) · 5.78 KB

Okta.Sdk.Api.OktaApplicationSettingsApi

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

Method HTTP request Description
GetFirstPartyAppSettings GET /api/v1/first-party-app-settings/{appName} Retrieve the Okta Application Settings
ReplaceFirstPartyAppSettings PUT /api/v1/first-party-app-settings/{appName} Replace the Okta Application Settings

GetFirstPartyAppSettings

AdminConsoleSettings GetFirstPartyAppSettings (string appName)

Retrieve the Okta Application Settings

Retrieves the settings for an Okta app (also known as an Okta first-party 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 GetFirstPartyAppSettingsExample
    {
        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 OktaApplicationSettingsApi(config);
            var appName = admin-console;  // string | The key name for the Okta app.<br> Supported apps:   * Okta Admin Console (`admin-console`) 

            try
            {
                // Retrieve the Okta Application Settings
                AdminConsoleSettings result = apiInstance.GetFirstPartyAppSettings(appName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OktaApplicationSettingsApi.GetFirstPartyAppSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
appName string The key name for the Okta app.<br> Supported apps: * Okta Admin Console (`admin-console`)

Return type

AdminConsoleSettings

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

ReplaceFirstPartyAppSettings

AdminConsoleSettings ReplaceFirstPartyAppSettings (string appName, AdminConsoleSettings adminConsoleSettings)

Replace the Okta Application Settings

Replaces the settings for an Okta app (also known as an Okta first-party 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 ReplaceFirstPartyAppSettingsExample
    {
        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 OktaApplicationSettingsApi(config);
            var appName = admin-console;  // string | The key name for the Okta app.<br> Supported apps:   * Okta Admin Console (`admin-console`) 
            var adminConsoleSettings = new AdminConsoleSettings(); // AdminConsoleSettings | 

            try
            {
                // Replace the Okta Application Settings
                AdminConsoleSettings result = apiInstance.ReplaceFirstPartyAppSettings(appName, adminConsoleSettings);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OktaApplicationSettingsApi.ReplaceFirstPartyAppSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
appName string The key name for the Okta app.<br> Supported apps: * Okta Admin Console (`admin-console`)
adminConsoleSettings AdminConsoleSettings

Return type

AdminConsoleSettings

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 -
429 Too Many Requests -

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