Skip to content

Latest commit

 

History

History
260 lines (202 loc) · 9.78 KB

AuthorizationServerAssocApi.md

File metadata and controls

260 lines (202 loc) · 9.78 KB

Okta.Sdk.Api.AuthorizationServerAssocApi

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

Method HTTP request Description
CreateAssociatedServers POST /api/v1/authorizationServers/{authServerId}/associatedServers Create an associated Authorization Server
DeleteAssociatedServer DELETE /api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId} Delete an associated Authorization Server
ListAssociatedServersByTrustedType GET /api/v1/authorizationServers/{authServerId}/associatedServers List all associated Authorization Servers

CreateAssociatedServers

List<AuthorizationServer> CreateAssociatedServers (string authServerId, AssociatedServerMediated associatedServerMediated)

Create an associated Authorization Server

Creates trusted relationships between the given authorization server and other authorization servers

Example

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

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

            try
            {
                // Create an associated Authorization Server
                List<AuthorizationServer> result = apiInstance.CreateAssociatedServers(authServerId, associatedServerMediated).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthorizationServerAssocApi.CreateAssociatedServers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<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]

DeleteAssociatedServer

void DeleteAssociatedServer (string authServerId, string associatedServerId)

Delete an associated Authorization Server

Deletes an associated 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 DeleteAssociatedServerExample
    {
        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 AuthorizationServerAssocApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server
            var associatedServerId = aus6xt9jKPmCyn6kg0g4;  // string | `id` of the associated Authorization Server

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

Parameters

Name Type Description Notes
authServerId string `id` of the Authorization Server
associatedServerId string `id` of the associated 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]

ListAssociatedServersByTrustedType

List<AuthorizationServer> ListAssociatedServersByTrustedType (string authServerId, bool? trusted = null, string q = null, int? limit = null, string after = null)

List all associated Authorization Servers

Lists all associated Authorization Servers by trusted type for the given authServerId

Example

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

namespace Example
{
    public class ListAssociatedServersByTrustedTypeExample
    {
        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 AuthorizationServerAssocApi(config);
            var authServerId = GeGRTEr7f3yu2n7grw22;  // string | `id` of the Authorization Server
            var trusted = true;  // bool? | Searches trusted authorization servers when `true` or searches untrusted authorization servers when `false` (optional) 
            var q = customasone;  // string | Searches for the name or audience of the associated authorization servers (optional) 
            var limit = 200;  // int? | Specifies the number of results for a page (optional)  (default to 200)
            var after = "after_example";  // string | Specifies the pagination cursor for the next page of the associated authorization servers (optional) 

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

Parameters

Name Type Description Notes
authServerId string `id` of the Authorization Server
trusted bool? Searches trusted authorization servers when `true` or searches untrusted authorization servers when `false` [optional]
q string Searches for the name or audience of the associated authorization servers [optional]
limit int? Specifies the number of results for a page [optional] [default to 200]
after string Specifies the pagination cursor for the next page of the associated authorization servers [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 -
404 Not Found -
429 Too Many Requests -

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