Okta.Sdk.Api.SSFReceiverApi

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

Method	HTTP request	Description
ActivateSecurityEventsProviderInstance	POST /api/v1/security-events-providers/{securityEventProviderId}/lifecycle/activate	Activate a Security Events Provider
CreateSecurityEventsProviderInstance	POST /api/v1/security-events-providers	Create a Security Events Provider
DeactivateSecurityEventsProviderInstance	POST /api/v1/security-events-providers/{securityEventProviderId}/lifecycle/deactivate	Deactivate a Security Events Provider
DeleteSecurityEventsProviderInstance	DELETE /api/v1/security-events-providers/{securityEventProviderId}	Delete a Security Events Provider
GetSecurityEventsProviderInstance	GET /api/v1/security-events-providers/{securityEventProviderId}	Retrieve the Security Events Provider
ListSecurityEventsProviderInstances	GET /api/v1/security-events-providers	List all Security Events Providers
ReplaceSecurityEventsProviderInstance	PUT /api/v1/security-events-providers/{securityEventProviderId}	Replace a Security Events Provider

ActivateSecurityEventsProviderInstance

SecurityEventsProviderResponse ActivateSecurityEventsProviderInstance (string securityEventProviderId)

Activate a Security Events Provider

Activates a Security Events Provider instance by setting its status to ACTIVE. This operation resumes the flow of events from the Security Events Provider to Okta.

Example

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

namespace Example
{
    public class ActivateSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var securityEventProviderId = sse1qg25RpusjUP6m0g5;  // string | `id` of the Security Events Provider instance

            try
            {
                // Activate a Security Events Provider
                SecurityEventsProviderResponse result = apiInstance.ActivateSecurityEventsProviderInstance(securityEventProviderId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.ActivateSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
securityEventProviderId	string	`id` of the Security Events Provider instance

Return type

SecurityEventsProviderResponse

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

CreateSecurityEventsProviderInstance

SecurityEventsProviderResponse CreateSecurityEventsProviderInstance (SecurityEventsProviderRequest instance)

Create a Security Events Provider

Creates a Security Events Provider instance

Example

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

namespace Example
{
    public class CreateSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var instance = new SecurityEventsProviderRequest(); // SecurityEventsProviderRequest | 

            try
            {
                // Create a Security Events Provider
                SecurityEventsProviderResponse result = apiInstance.CreateSecurityEventsProviderInstance(instance);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.CreateSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
instance	SecurityEventsProviderRequest

Return type

SecurityEventsProviderResponse

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-

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

DeactivateSecurityEventsProviderInstance

SecurityEventsProviderResponse DeactivateSecurityEventsProviderInstance (string securityEventProviderId)

Deactivate a Security Events Provider

Deactivates a Security Events Provider instance by setting its status to INACTIVE. This operation stops the flow of events from the Security Events Provider to Okta.

Example

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

namespace Example
{
    public class DeactivateSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var securityEventProviderId = sse1qg25RpusjUP6m0g5;  // string | `id` of the Security Events Provider instance

            try
            {
                // Deactivate a Security Events Provider
                SecurityEventsProviderResponse result = apiInstance.DeactivateSecurityEventsProviderInstance(securityEventProviderId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.DeactivateSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
securityEventProviderId	string	`id` of the Security Events Provider instance

Return type

SecurityEventsProviderResponse

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

DeleteSecurityEventsProviderInstance

void DeleteSecurityEventsProviderInstance (string securityEventProviderId)

Delete a Security Events Provider

Deletes a Security Events Provider instance specified 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 DeleteSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var securityEventProviderId = sse1qg25RpusjUP6m0g5;  // string | `id` of the Security Events Provider instance

            try
            {
                // Delete a Security Events Provider
                apiInstance.DeleteSecurityEventsProviderInstance(securityEventProviderId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.DeleteSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
securityEventProviderId	string	`id` of the Security Events Provider instance

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

GetSecurityEventsProviderInstance

SecurityEventsProviderResponse GetSecurityEventsProviderInstance (string securityEventProviderId)

Retrieve the Security Events Provider

Retrieves the Security Events Provider instance specified 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 GetSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var securityEventProviderId = sse1qg25RpusjUP6m0g5;  // string | `id` of the Security Events Provider instance

            try
            {
                // Retrieve the Security Events Provider
                SecurityEventsProviderResponse result = apiInstance.GetSecurityEventsProviderInstance(securityEventProviderId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.GetSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
securityEventProviderId	string	`id` of the Security Events Provider instance

Return type

SecurityEventsProviderResponse

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

ListSecurityEventsProviderInstances

List<SecurityEventsProviderResponse> ListSecurityEventsProviderInstances ()

List all Security Events Providers

Lists all Security Events Provider instances

Example

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

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

            try
            {
                // List all Security Events Providers
                List<SecurityEventsProviderResponse> result = apiInstance.ListSecurityEventsProviderInstances().ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.ListSecurityEventsProviderInstances: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<SecurityEventsProviderResponse>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

ReplaceSecurityEventsProviderInstance

SecurityEventsProviderResponse ReplaceSecurityEventsProviderInstance (string securityEventProviderId, SecurityEventsProviderRequest instance)

Replace a Security Events Provider

Replaces a Security Events Provider instance specified 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 ReplaceSecurityEventsProviderInstanceExample
    {
        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 SSFReceiverApi(config);
            var securityEventProviderId = sse1qg25RpusjUP6m0g5;  // string | `id` of the Security Events Provider instance
            var instance = new SecurityEventsProviderRequest(); // SecurityEventsProviderRequest | 

            try
            {
                // Replace a Security Events Provider
                SecurityEventsProviderResponse result = apiInstance.ReplaceSecurityEventsProviderInstance(securityEventProviderId, instance);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SSFReceiverApi.ReplaceSecurityEventsProviderInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
securityEventProviderId	string	`id` of the Security Events Provider instance
instance	SecurityEventsProviderRequest

Return type

SecurityEventsProviderResponse

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

Files

SSFReceiverApi.md

Latest commit

History

SSFReceiverApi.md

File metadata and controls

Okta.Sdk.Api.SSFReceiverApi

ActivateSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListSecurityEventsProviderInstances

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceSecurityEventsProviderInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details