Okta.Sdk.Api.RateLimitSettingsApi

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

Method	HTTP request	Description
GetRateLimitSettingsAdminNotifications	GET /api/v1/rate-limit-settings/admin-notifications	Retrieve the Rate Limit Admin Notification Settings
GetRateLimitSettingsPerClient	GET /api/v1/rate-limit-settings/per-client	Retrieve the Per-Client Rate Limit Settings
GetRateLimitSettingsWarningThreshold	GET /api/v1/rate-limit-settings/warning-threshold	Retrieve the Rate Limit Warning Threshold Percentage
ReplaceRateLimitSettingsAdminNotifications	PUT /api/v1/rate-limit-settings/admin-notifications	Replace the Rate Limit Admin Notification Settings
ReplaceRateLimitSettingsPerClient	PUT /api/v1/rate-limit-settings/per-client	Replace the Per-Client Rate Limit Settings
ReplaceRateLimitSettingsWarningThreshold	PUT /api/v1/rate-limit-settings/warning-threshold	Replace the Rate Limit Warning Threshold Percentage

GetRateLimitSettingsAdminNotifications

RateLimitAdminNotifications GetRateLimitSettingsAdminNotifications ()

Retrieve the Rate Limit Admin Notification Settings

Retrieves the currently configured Rate Limit Admin Notification Settings

Example

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

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

            try
            {
                // Retrieve the Rate Limit Admin Notification Settings
                RateLimitAdminNotifications result = apiInstance.GetRateLimitSettingsAdminNotifications();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.GetRateLimitSettingsAdminNotifications: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

RateLimitAdminNotifications

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]

GetRateLimitSettingsPerClient

PerClientRateLimitSettings GetRateLimitSettingsPerClient ()

Retrieve the Per-Client Rate Limit Settings

Retrieves the currently configured Per-Client Rate Limit Settings

Example

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

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

            try
            {
                // Retrieve the Per-Client Rate Limit Settings
                PerClientRateLimitSettings result = apiInstance.GetRateLimitSettingsPerClient();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.GetRateLimitSettingsPerClient: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PerClientRateLimitSettings

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]

GetRateLimitSettingsWarningThreshold

RateLimitWarningThresholdResponse GetRateLimitSettingsWarningThreshold ()

Retrieve the Rate Limit Warning Threshold Percentage

Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded

Example

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

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

            try
            {
                // Retrieve the Rate Limit Warning Threshold Percentage
                RateLimitWarningThresholdResponse result = apiInstance.GetRateLimitSettingsWarningThreshold();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.GetRateLimitSettingsWarningThreshold: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

RateLimitWarningThresholdResponse

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]

ReplaceRateLimitSettingsAdminNotifications

RateLimitAdminNotifications ReplaceRateLimitSettingsAdminNotifications (RateLimitAdminNotifications rateLimitAdminNotifications)

Replace the Rate Limit Admin Notification Settings

Replaces the Rate Limit Admin Notification Settings and returns the configured properties

Example

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

namespace Example
{
    public class ReplaceRateLimitSettingsAdminNotificationsExample
    {
        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 RateLimitSettingsApi(config);
            var rateLimitAdminNotifications = new RateLimitAdminNotifications(); // RateLimitAdminNotifications | 

            try
            {
                // Replace the Rate Limit Admin Notification Settings
                RateLimitAdminNotifications result = apiInstance.ReplaceRateLimitSettingsAdminNotifications(rateLimitAdminNotifications);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.ReplaceRateLimitSettingsAdminNotifications: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
rateLimitAdminNotifications	RateLimitAdminNotifications

Return type

RateLimitAdminNotifications

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]

ReplaceRateLimitSettingsPerClient

PerClientRateLimitSettings ReplaceRateLimitSettingsPerClient (PerClientRateLimitSettings perClientRateLimitSettings)

Replace the Per-Client Rate Limit Settings

Replaces the Per-Client Rate Limit Settings and returns the configured properties

Example

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

namespace Example
{
    public class ReplaceRateLimitSettingsPerClientExample
    {
        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 RateLimitSettingsApi(config);
            var perClientRateLimitSettings = new PerClientRateLimitSettings(); // PerClientRateLimitSettings | 

            try
            {
                // Replace the Per-Client Rate Limit Settings
                PerClientRateLimitSettings result = apiInstance.ReplaceRateLimitSettingsPerClient(perClientRateLimitSettings);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.ReplaceRateLimitSettingsPerClient: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
perClientRateLimitSettings	PerClientRateLimitSettings

Return type

PerClientRateLimitSettings

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]

ReplaceRateLimitSettingsWarningThreshold

RateLimitWarningThresholdResponse ReplaceRateLimitSettingsWarningThreshold (RateLimitWarningThresholdRequest rateLimitWarningThreshold = null)

Replace the Rate Limit Warning Threshold Percentage

Replaces the Rate Limit Warning Threshold Percentage and returns the configured property

Example

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

namespace Example
{
    public class ReplaceRateLimitSettingsWarningThresholdExample
    {
        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 RateLimitSettingsApi(config);
            var rateLimitWarningThreshold = new RateLimitWarningThresholdRequest(); // RateLimitWarningThresholdRequest |  (optional) 

            try
            {
                // Replace the Rate Limit Warning Threshold Percentage
                RateLimitWarningThresholdResponse result = apiInstance.ReplaceRateLimitSettingsWarningThreshold(rateLimitWarningThreshold);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RateLimitSettingsApi.ReplaceRateLimitSettingsWarningThreshold: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
rateLimitWarningThreshold	RateLimitWarningThresholdRequest		[optional]

Return type

RateLimitWarningThresholdResponse

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]

Files

RateLimitSettingsApi.md

Latest commit

History

RateLimitSettingsApi.md

File metadata and controls

Okta.Sdk.Api.RateLimitSettingsApi

GetRateLimitSettingsAdminNotifications

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetRateLimitSettingsPerClient

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetRateLimitSettingsWarningThreshold

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceRateLimitSettingsAdminNotifications

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceRateLimitSettingsPerClient

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceRateLimitSettingsWarningThreshold

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details