Okta.Sdk.Api.ApiServiceIntegrationsApi

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

Method	HTTP request	Description
ActivateApiServiceIntegrationInstanceSecret	POST /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activate	Activate an API Service Integration instance Secret
CreateApiServiceIntegrationInstance	POST /integrations/api/v1/api-services	Create an API Service Integration instance
CreateApiServiceIntegrationInstanceSecret	POST /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets	Create an API Service Integration instance Secret
DeactivateApiServiceIntegrationInstanceSecret	POST /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivate	Deactivate an API Service Integration instance Secret
DeleteApiServiceIntegrationInstance	DELETE /integrations/api/v1/api-services/{apiServiceId}	Delete an API Service Integration instance
DeleteApiServiceIntegrationInstanceSecret	DELETE /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}	Delete an API Service Integration instance Secret
GetApiServiceIntegrationInstance	GET /integrations/api/v1/api-services/{apiServiceId}	Retrieve an API Service Integration instance
ListApiServiceIntegrationInstanceSecrets	GET /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets	List all API Service Integration instance Secrets
ListApiServiceIntegrationInstances	GET /integrations/api/v1/api-services	List 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

Name	Type	Description	Notes
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`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 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]

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";

            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

Name	Type	Description	Notes
postAPIServiceIntegrationInstanceRequest	PostAPIServiceIntegrationInstanceRequest

Return type

PostAPIServiceIntegrationInstance

Authorization

apiToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
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]

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

Name	Type	Description	Notes
apiServiceId	string	`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 code	Description	Response headers
201	Created	-
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]

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

Name	Type	Description	Notes
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`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 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]

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

Name	Type	Description	Notes
apiServiceId	string	`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 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]

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

Name	Type	Description	Notes
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`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 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]

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

Name	Type	Description	Notes
apiServiceId	string	`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 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]

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

Name	Type	Description	Notes
apiServiceId	string	`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 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]

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](/#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

Name	Type	Description	Notes
after	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.	[optional]

Return type

List<APIServiceIntegrationInstance>

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]

Files

ApiServiceIntegrationsApi.md

Latest commit

History

ApiServiceIntegrationsApi.md

File metadata and controls

Okta.Sdk.Api.ApiServiceIntegrationsApi

ActivateApiServiceIntegrationInstanceSecret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateApiServiceIntegrationInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateApiServiceIntegrationInstanceSecret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateApiServiceIntegrationInstanceSecret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteApiServiceIntegrationInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteApiServiceIntegrationInstanceSecret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetApiServiceIntegrationInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListApiServiceIntegrationInstanceSecrets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListApiServiceIntegrationInstances

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details