Okta.Sdk.Api.TrustedOriginApi

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

Method	HTTP request	Description
ActivateTrustedOrigin	POST /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate	Activate a Trusted Origin
CreateTrustedOrigin	POST /api/v1/trustedOrigins	Create a Trusted Origin
DeactivateTrustedOrigin	POST /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate	Deactivate a Trusted Origin
DeleteTrustedOrigin	DELETE /api/v1/trustedOrigins/{trustedOriginId}	Delete a Trusted Origin
GetTrustedOrigin	GET /api/v1/trustedOrigins/{trustedOriginId}	Retrieve a Trusted Origin
ListTrustedOrigins	GET /api/v1/trustedOrigins	List all Trusted Origins
ReplaceTrustedOrigin	PUT /api/v1/trustedOrigins/{trustedOriginId}	Replace a Trusted Origin

ActivateTrustedOrigin

TrustedOrigin ActivateTrustedOrigin (string trustedOriginId)

Activate a Trusted Origin

Activates a Trusted Origin. Sets the status to ACTIVE.

Example

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

namespace Example
{
    public class ActivateTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOriginId = 7j2PkU1nyNIDe26ZNufR;  // string | `id` of the Trusted Origin

            try
            {
                // Activate a Trusted Origin
                TrustedOrigin result = apiInstance.ActivateTrustedOrigin(trustedOriginId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.ActivateTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOriginId	string	`id` of the Trusted Origin

Return type

TrustedOrigin

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	-
404	Not Found	-
429	Too Many Requests	-

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

CreateTrustedOrigin

TrustedOrigin CreateTrustedOrigin (TrustedOriginWrite trustedOrigin)

Create a Trusted Origin

Creates a trusted origin

Example

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

namespace Example
{
    public class CreateTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOrigin = new TrustedOriginWrite(); // TrustedOriginWrite | 

            try
            {
                // Create a Trusted Origin
                TrustedOrigin result = apiInstance.CreateTrustedOrigin(trustedOrigin);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.CreateTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOrigin	TrustedOriginWrite

Return type

TrustedOrigin

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]

DeactivateTrustedOrigin

TrustedOrigin DeactivateTrustedOrigin (string trustedOriginId)

Deactivate a Trusted Origin

Deactivates a Trusted Origin. Sets the status to INACTIVE.

Example

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

namespace Example
{
    public class DeactivateTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOriginId = 7j2PkU1nyNIDe26ZNufR;  // string | `id` of the Trusted Origin

            try
            {
                // Deactivate a Trusted Origin
                TrustedOrigin result = apiInstance.DeactivateTrustedOrigin(trustedOriginId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.DeactivateTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOriginId	string	`id` of the Trusted Origin

Return type

TrustedOrigin

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	-
404	Not Found	-
429	Too Many Requests	-

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

DeleteTrustedOrigin

void DeleteTrustedOrigin (string trustedOriginId)

Delete a Trusted Origin

Deletes a trusted origin

Example

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

namespace Example
{
    public class DeleteTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOriginId = 7j2PkU1nyNIDe26ZNufR;  // string | `id` of the Trusted Origin

            try
            {
                // Delete a Trusted Origin
                apiInstance.DeleteTrustedOrigin(trustedOriginId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.DeleteTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOriginId	string	`id` of the Trusted Origin

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	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

GetTrustedOrigin

TrustedOrigin GetTrustedOrigin (string trustedOriginId)

Retrieve a Trusted Origin

Retrieves a trusted origin

Example

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

namespace Example
{
    public class GetTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOriginId = 7j2PkU1nyNIDe26ZNufR;  // string | `id` of the Trusted Origin

            try
            {
                // Retrieve a Trusted Origin
                TrustedOrigin result = apiInstance.GetTrustedOrigin(trustedOriginId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.GetTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOriginId	string	`id` of the Trusted Origin

Return type

TrustedOrigin

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	-
404	Not Found	-
429	Too Many Requests	-

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

ListTrustedOrigins

List<TrustedOrigin> ListTrustedOrigins (string q = null, string filter = null, string after = null, int? limit = null)

List all Trusted Origins

Lists all trusted origins

Example

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

namespace Example
{
    public class ListTrustedOriginsExample
    {
        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 TrustedOriginApi(config);
            var q = "q_example";  // string | A search string that will prefix match against the `name` and `origin` (optional) 
            var filter = name eq "Example Trusted Origin";  // string | [Filter](/#filter) Trusted Origins with a supported expression for a subset of properties. You can filter on the following properties: `name`, `origin`, `status`, and `type` (type of scopes).  (optional) 
            var after = "after_example";  // string | The after cursor provided by a prior request. (optional) 
            var limit = 20;  // int? | Specifies the number of results. (optional)  (default to 20)

            try
            {
                // List all Trusted Origins
                List<TrustedOrigin> result = apiInstance.ListTrustedOrigins(q, filter, after, limit).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.ListTrustedOrigins: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
q	string	A search string that will prefix match against the `name` and `origin`	[optional]
filter	string	Filter Trusted Origins with a supported expression for a subset of properties. You can filter on the following properties: `name`, `origin`, `status`, and `type` (type of scopes).	[optional]
after	string	The after cursor provided by a prior request.	[optional]
limit	int?	Specifies the number of results.	[optional] [default to 20]

Return type

List<TrustedOrigin>

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]

ReplaceTrustedOrigin

TrustedOrigin ReplaceTrustedOrigin (string trustedOriginId, TrustedOrigin trustedOrigin)

Replace a Trusted Origin

Replaces a trusted origin

Example

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

namespace Example
{
    public class ReplaceTrustedOriginExample
    {
        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 TrustedOriginApi(config);
            var trustedOriginId = 7j2PkU1nyNIDe26ZNufR;  // string | `id` of the Trusted Origin
            var trustedOrigin = new TrustedOrigin(); // TrustedOrigin | 

            try
            {
                // Replace a Trusted Origin
                TrustedOrigin result = apiInstance.ReplaceTrustedOrigin(trustedOriginId, trustedOrigin);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TrustedOriginApi.ReplaceTrustedOrigin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
trustedOriginId	string	`id` of the Trusted Origin
trustedOrigin	TrustedOrigin

Return type

TrustedOrigin

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	-
404	Not Found	-
429	Too Many Requests	-

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

Files

TrustedOriginApi.md

Latest commit

History

TrustedOriginApi.md

File metadata and controls

Okta.Sdk.Api.TrustedOriginApi

ActivateTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListTrustedOrigins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceTrustedOrigin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details