Okta.Sdk.Api.ApiServiceIntegrationsApi

October 22, 2025 ยท View on GitHub

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

MethodHTTP requestDescription
ActivateApiServiceIntegrationInstanceSecretPOST /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activateActivate an API service integration instance secret
CreateApiServiceIntegrationInstancePOST /integrations/api/v1/api-servicesCreate an API service integration instance
CreateApiServiceIntegrationInstanceSecretPOST /integrations/api/v1/api-services/{apiServiceId}/credentials/secretsCreate an API service integration instance secret
DeactivateApiServiceIntegrationInstanceSecretPOST /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivateDeactivate an API service integration instance secret
DeleteApiServiceIntegrationInstanceDELETE /integrations/api/v1/api-services/{apiServiceId}Delete an API service integration instance
DeleteApiServiceIntegrationInstanceSecretDELETE /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}Delete an API service integration instance secret
GetApiServiceIntegrationInstanceGET /integrations/api/v1/api-services/{apiServiceId}Retrieve an API service integration instance
ListApiServiceIntegrationInstanceSecretsGET /integrations/api/v1/api-services/{apiServiceId}/credentials/secretsList all API service integration instance secrets
ListApiServiceIntegrationInstancesGET /integrations/api/v1/api-servicesList all API service integration instances

ActivateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret ActivateApiServiceIntegrationInstanceSecret (string apiServiceId, string secretId)

Activate an API service integration instance secret

Activates an API Service Integration instance Secret by secretId

Example

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

namespace Example
{
    public class ActivateApiServiceIntegrationInstanceSecretExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance
            var secretId = ocs2f4zrZbs8nUa7p0g4;  // string | `id` of the API Service Integration instance Secret

            try
            {
                // Activate an API service integration instance secret
                APIServiceIntegrationInstanceSecret result = apiInstance.ActivateApiServiceIntegrationInstanceSecret(apiServiceId, secretId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.ActivateApiServiceIntegrationInstanceSecret: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance
secretIdstring`id` of the API Service Integration instance Secret

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

CreateApiServiceIntegrationInstance

PostAPIServiceIntegrationInstance CreateApiServiceIntegrationInstance (PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest)

Create an API service integration instance

Creates and authorizes an API Service Integration 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 CreateApiServiceIntegrationInstanceExample
    {
        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 ApiServiceIntegrationsApi(config);
            var postAPIServiceIntegrationInstanceRequest = new PostAPIServiceIntegrationInstanceRequest(); // PostAPIServiceIntegrationInstanceRequest | 

            try
            {
                // Create an API service integration instance
                PostAPIServiceIntegrationInstance result = apiInstance.CreateApiServiceIntegrationInstance(postAPIServiceIntegrationInstanceRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.CreateApiServiceIntegrationInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
postAPIServiceIntegrationInstanceRequestPostAPIServiceIntegrationInstanceRequest

Return type

PostAPIServiceIntegrationInstance

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
201Created-
400Bad Request-
401Unauthorized-
403Forbidden-
429Too Many Requests-

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

CreateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret CreateApiServiceIntegrationInstanceSecret (string apiServiceId)

Create an API service integration instance secret

Creates an API Service Integration instance Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects.

Example

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

namespace Example
{
    public class CreateApiServiceIntegrationInstanceSecretExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance

            try
            {
                // Create an API service integration instance secret
                APIServiceIntegrationInstanceSecret result = apiInstance.CreateApiServiceIntegrationInstanceSecret(apiServiceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.CreateApiServiceIntegrationInstanceSecret: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
201Created-
400Bad Request-
401Unauthorized-
403Forbidden-
429Too Many Requests-

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

DeactivateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret DeactivateApiServiceIntegrationInstanceSecret (string apiServiceId, string secretId)

Deactivate an API service integration instance secret

Deactivates an API Service Integration instance Secret by secretId

Example

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

namespace Example
{
    public class DeactivateApiServiceIntegrationInstanceSecretExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance
            var secretId = ocs2f4zrZbs8nUa7p0g4;  // string | `id` of the API Service Integration instance Secret

            try
            {
                // Deactivate an API service integration instance secret
                APIServiceIntegrationInstanceSecret result = apiInstance.DeactivateApiServiceIntegrationInstanceSecret(apiServiceId, secretId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.DeactivateApiServiceIntegrationInstanceSecret: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance
secretIdstring`id` of the API Service Integration instance Secret

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

DeleteApiServiceIntegrationInstance

void DeleteApiServiceIntegrationInstance (string apiServiceId)

Delete an API service integration instance

Deletes an API Service Integration instance by id. This operation also revokes access to scopes that were previously granted to this API Service Integration 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 DeleteApiServiceIntegrationInstanceExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance

            try
            {
                // Delete an API service integration instance
                apiInstance.DeleteApiServiceIntegrationInstance(apiServiceId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.DeleteApiServiceIntegrationInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

DeleteApiServiceIntegrationInstanceSecret

void DeleteApiServiceIntegrationInstanceSecret (string apiServiceId, string secretId)

Delete an API service integration instance secret

Deletes an API Service Integration instance Secret by secretId. You can only delete an inactive Secret.

Example

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

namespace Example
{
    public class DeleteApiServiceIntegrationInstanceSecretExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance
            var secretId = ocs2f4zrZbs8nUa7p0g4;  // string | `id` of the API Service Integration instance Secret

            try
            {
                // Delete an API service integration instance secret
                apiInstance.DeleteApiServiceIntegrationInstanceSecret(apiServiceId, secretId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.DeleteApiServiceIntegrationInstanceSecret: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance
secretIdstring`id` of the API Service Integration instance Secret

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

GetApiServiceIntegrationInstance

APIServiceIntegrationInstance GetApiServiceIntegrationInstance (string apiServiceId)

Retrieve an API service integration instance

Retrieves an API Service Integration instance 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 GetApiServiceIntegrationInstanceExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance

            try
            {
                // Retrieve an API service integration instance
                APIServiceIntegrationInstance result = apiInstance.GetApiServiceIntegrationInstance(apiServiceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.GetApiServiceIntegrationInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance

Return type

APIServiceIntegrationInstance

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

ListApiServiceIntegrationInstanceSecrets

List<APIServiceIntegrationInstanceSecret> ListApiServiceIntegrationInstanceSecrets (string apiServiceId)

List all API service integration instance secrets

Lists all client secrets for an API Service Integration instance by apiServiceId

Example

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

namespace Example
{
    public class ListApiServiceIntegrationInstanceSecretsExample
    {
        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 ApiServiceIntegrationsApi(config);
            var apiServiceId = 000lr2rLjZ6NsGn1P0g3;  // string | `id` of the API Service Integration instance

            try
            {
                // List all API service integration instance secrets
                List<APIServiceIntegrationInstanceSecret> result = apiInstance.ListApiServiceIntegrationInstanceSecrets(apiServiceId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.ListApiServiceIntegrationInstanceSecrets: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiServiceIdstring`id` of the API Service Integration instance

Return type

List<APIServiceIntegrationInstanceSecret>

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

ListApiServiceIntegrationInstances

List<APIServiceIntegrationInstance> ListApiServiceIntegrationInstances (string after = null)

List all API service integration instances

Lists all API Service Integration instances with a pagination option

Example

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

namespace Example
{
    public class ListApiServiceIntegrationInstancesExample
    {
        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 ApiServiceIntegrationsApi(config);
            var after = "after_example";  // string | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional) 

            try
            {
                // List all API service integration instances
                List<APIServiceIntegrationInstance> result = apiInstance.ListApiServiceIntegrationInstances(after).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ApiServiceIntegrationsApi.ListApiServiceIntegrationInstances: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
afterstringThe cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination.[optional]

Return type

List<APIServiceIntegrationInstance>

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
429Too Many Requests-

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