Okta.Sdk.Api.AuthorizationServerApi

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

Method	HTTP request	Description
ActivateAuthorizationServer	POST /api/v1/authorizationServers/{authServerId}/lifecycle/activate	Activate an Authorization Server
CreateAuthorizationServer	POST /api/v1/authorizationServers	Create an Authorization Server
DeactivateAuthorizationServer	POST /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate	Deactivate an Authorization Server
DeleteAuthorizationServer	DELETE /api/v1/authorizationServers/{authServerId}	Delete an Authorization Server
GetAuthorizationServer	GET /api/v1/authorizationServers/{authServerId}	Retrieve an Authorization Server
ListAuthorizationServers	GET /api/v1/authorizationServers	List all Authorization Servers
ReplaceAuthorizationServer	PUT /api/v1/authorizationServers/{authServerId}	Replace an Authorization Server

ActivateAuthorizationServer

void ActivateAuthorizationServer (string authServerId)

Activate an Authorization Server

Activates an authorization server

Example

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

namespace Example
{
    public class ActivateAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server

            try
            {
                // Activate an Authorization Server
                apiInstance.ActivateAuthorizationServer(authServerId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.ActivateAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authServerId	string	`id` of the Authorization Server

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

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

CreateAuthorizationServer

AuthorizationServer CreateAuthorizationServer (AuthorizationServer authorizationServer)

Create an Authorization Server

Creates an authorization server

Example

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

namespace Example
{
    public class CreateAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authorizationServer = new AuthorizationServer(); // AuthorizationServer | 

            try
            {
                // Create an Authorization Server
                AuthorizationServer result = apiInstance.CreateAuthorizationServer(authorizationServer);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.CreateAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authorizationServer	AuthorizationServer

Return type

AuthorizationServer

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too Many Requests	-

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

DeactivateAuthorizationServer

void DeactivateAuthorizationServer (string authServerId)

Deactivate an Authorization Server

Deactivates an authorization server

Example

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

namespace Example
{
    public class DeactivateAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server

            try
            {
                // Deactivate an Authorization Server
                apiInstance.DeactivateAuthorizationServer(authServerId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.DeactivateAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authServerId	string	`id` of the Authorization Server

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

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

DeleteAuthorizationServer

void DeleteAuthorizationServer (string authServerId)

Delete an Authorization Server

Deletes an authorization server

Example

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

namespace Example
{
    public class DeleteAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server

            try
            {
                // Delete an Authorization Server
                apiInstance.DeleteAuthorizationServer(authServerId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.DeleteAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authServerId	string	`id` of the Authorization Server

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

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

GetAuthorizationServer

AuthorizationServer GetAuthorizationServer (string authServerId)

Retrieve an Authorization Server

Retrieves an authorization server

Example

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

namespace Example
{
    public class GetAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server

            try
            {
                // Retrieve an Authorization Server
                AuthorizationServer result = apiInstance.GetAuthorizationServer(authServerId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.GetAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authServerId	string	`id` of the Authorization Server

Return type

AuthorizationServer

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]

ListAuthorizationServers

List<AuthorizationServer> ListAuthorizationServers (string q = null, int? limit = null, string after = null)

List all Authorization Servers

Lists all custom authorization servers in the org

Example

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

namespace Example
{
    public class ListAuthorizationServersExample
    {
        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 AuthorizationServerApi(config);
            var q = customasone;  // string | Searches the `name` and `audiences` of authorization servers for matching values (optional) 
            var limit = 200;  // int? | Specifies the number of authorization server results on a page. Maximum value: 200 (optional)  (default to 200)
            var after = "after_example";  // string | Specifies the pagination cursor for the next page of authorization servers. Treat as an opaque value and obtain through the next link relationship. (optional) 

            try
            {
                // List all Authorization Servers
                List<AuthorizationServer> result = apiInstance.ListAuthorizationServers(q, limit, after).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.ListAuthorizationServers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
q	string	Searches the `name` and `audiences` of authorization servers for matching values	[optional]
limit	int?	Specifies the number of authorization server results on a page. Maximum value: 200	[optional] [default to 200]
after	string	Specifies the pagination cursor for the next page of authorization servers. Treat as an opaque value and obtain through the next link relationship.	[optional]

Return type

List<AuthorizationServer>

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]

ReplaceAuthorizationServer

AuthorizationServer ReplaceAuthorizationServer (string authServerId, AuthorizationServer authorizationServer)

Replace an Authorization Server

Replaces an authorization server

Example

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

namespace Example
{
    public class ReplaceAuthorizationServerExample
    {
        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 AuthorizationServerApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server
            var authorizationServer = new AuthorizationServer(); // AuthorizationServer | 

            try
            {
                // Replace an Authorization Server
                AuthorizationServer result = apiInstance.ReplaceAuthorizationServer(authServerId, authorizationServer);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerApi.ReplaceAuthorizationServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
authServerId	string	`id` of the Authorization Server
authorizationServer	AuthorizationServer

Return type

AuthorizationServer

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

AuthorizationServerApi.md

Latest commit

History

AuthorizationServerApi.md

File metadata and controls

Okta.Sdk.Api.AuthorizationServerApi

ActivateAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListAuthorizationServers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceAuthorizationServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details