Okta.Sdk.Api.OrgSettingAdminApi

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

Method	HTTP request	Description
AssignClientPrivilegesSetting	PUT /api/v1/org/settings/clientPrivilegesSetting	Assign the default public client app role setting
GetAutoAssignAdminAppSetting	GET /api/v1/org/settings/autoAssignAdminAppSetting	Retrieve the Okta Admin Console assignment setting
GetClientPrivilegesSetting	GET /api/v1/org/settings/clientPrivilegesSetting	Retrieve the default public client app role setting
GetThirdPartyAdminSetting	GET /api/v1/org/orgSettings/thirdPartyAdminSetting	Retrieve the org third-party admin setting
UpdateAutoAssignAdminAppSetting	POST /api/v1/org/settings/autoAssignAdminAppSetting	Update the Okta Admin Console assignment setting
UpdateThirdPartyAdminSetting	POST /api/v1/org/orgSettings/thirdPartyAdminSetting	Update the org third-party admin setting

AssignClientPrivilegesSetting

ClientPrivilegesSetting AssignClientPrivilegesSetting (ClientPrivilegesSetting clientPrivilegesSetting = null)

Assign the default public client app role setting

Assigns the Super Admin role as the default role for new public client apps

Example

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

namespace Example
{
    public class AssignClientPrivilegesSettingExample
    {
        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 OrgSettingAdminApi(config);
            var clientPrivilegesSetting = new ClientPrivilegesSetting(); // ClientPrivilegesSetting |  (optional) 

            try
            {
                // Assign the default public client app role setting
                ClientPrivilegesSetting result = apiInstance.AssignClientPrivilegesSetting(clientPrivilegesSetting);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.AssignClientPrivilegesSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
clientPrivilegesSetting	ClientPrivilegesSetting		[optional]

Return type

ClientPrivilegesSetting

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
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]

GetAutoAssignAdminAppSetting

AutoAssignAdminAppSetting GetAutoAssignAdminAppSetting ()

Retrieve the Okta Admin Console assignment setting

Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned

Example

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

namespace Example
{
    public class GetAutoAssignAdminAppSettingExample
    {
        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 OrgSettingAdminApi(config);

            try
            {
                // Retrieve the Okta Admin Console assignment setting
                AutoAssignAdminAppSetting result = apiInstance.GetAutoAssignAdminAppSetting();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.GetAutoAssignAdminAppSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

AutoAssignAdminAppSetting

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]

GetClientPrivilegesSetting

ClientPrivilegesSetting GetClientPrivilegesSetting ()

Retrieve the default public client app role setting

Retrieves the org setting to assign the Super Admin role to new public client apps

Example

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

namespace Example
{
    public class GetClientPrivilegesSettingExample
    {
        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 OrgSettingAdminApi(config);

            try
            {
                // Retrieve the default public client app role setting
                ClientPrivilegesSetting result = apiInstance.GetClientPrivilegesSetting();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.GetClientPrivilegesSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ClientPrivilegesSetting

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]

GetThirdPartyAdminSetting

ThirdPartyAdminSetting GetThirdPartyAdminSetting ()

Retrieve the org third-party admin setting

Retrieves the third-party admin setting. See Configure third-party administrators in the Okta product documentation.

Example

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

namespace Example
{
    public class GetThirdPartyAdminSettingExample
    {
        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 OrgSettingAdminApi(config);

            try
            {
                // Retrieve the org third-party admin setting
                ThirdPartyAdminSetting result = apiInstance.GetThirdPartyAdminSetting();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.GetThirdPartyAdminSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ThirdPartyAdminSetting

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]

UpdateAutoAssignAdminAppSetting

AutoAssignAdminAppSetting UpdateAutoAssignAdminAppSetting (AutoAssignAdminAppSetting autoAssignAdminAppSetting = null)

Update the Okta Admin Console assignment setting

Updates the org setting to automatically assign the Okta Admin Console when an admin role is assigned > Note: This setting doesn't apply to the SUPER_ADMIN role. > When you assign the SUPER_ADMIN role to a user, the Admin Console is always assigned to the user regardless of the autoAssignAdminAppSetting setting.

Example

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

namespace Example
{
    public class UpdateAutoAssignAdminAppSettingExample
    {
        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 OrgSettingAdminApi(config);
            var autoAssignAdminAppSetting = new AutoAssignAdminAppSetting(); // AutoAssignAdminAppSetting |  (optional) 

            try
            {
                // Update the Okta Admin Console assignment setting
                AutoAssignAdminAppSetting result = apiInstance.UpdateAutoAssignAdminAppSetting(autoAssignAdminAppSetting);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.UpdateAutoAssignAdminAppSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
autoAssignAdminAppSetting	AutoAssignAdminAppSetting		[optional]

Return type

AutoAssignAdminAppSetting

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
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]

UpdateThirdPartyAdminSetting

ThirdPartyAdminSetting UpdateThirdPartyAdminSetting (ThirdPartyAdminSetting thirdPartyAdminSetting)

Update the org third-party admin setting

Updates the third-party admin setting. This setting allows third-party admins to perform administrative actions in the Admin Console, but they can't do any of the following: * Receive Okta admin email notifications * Contact Okta support * Sign in to the Okta Help Center See Configure third-party administrators in the Okta product documentation.

Example

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

namespace Example
{
    public class UpdateThirdPartyAdminSettingExample
    {
        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 OrgSettingAdminApi(config);
            var thirdPartyAdminSetting = new ThirdPartyAdminSetting(); // ThirdPartyAdminSetting | 

            try
            {
                // Update the org third-party admin setting
                ThirdPartyAdminSetting result = apiInstance.UpdateThirdPartyAdminSetting(thirdPartyAdminSetting);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrgSettingAdminApi.UpdateThirdPartyAdminSetting: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
thirdPartyAdminSetting	ThirdPartyAdminSetting

Return type

ThirdPartyAdminSetting

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
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]

FilesExpand file tree

OrgSettingAdminApi.md

Latest commit

History

OrgSettingAdminApi.md

File metadata and controls

Okta.Sdk.Api.OrgSettingAdminApi

AssignClientPrivilegesSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetAutoAssignAdminAppSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetClientPrivilegesSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetThirdPartyAdminSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateAutoAssignAdminAppSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateThirdPartyAdminSetting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details