Skip to content

Latest commit

 

History

History
323 lines (248 loc) · 9.97 KB

LinkedObjectApi.md

File metadata and controls

323 lines (248 loc) · 9.97 KB

Okta.Sdk.Api.LinkedObjectApi

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

Method HTTP request Description
CreateLinkedObjectDefinition POST /api/v1/meta/schemas/user/linkedObjects Create a Linked Object Definition
DeleteLinkedObjectDefinition DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} Delete a Linked Object Definition
GetLinkedObjectDefinition GET /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} Retrieve a Linked Object Definition
ListLinkedObjectDefinitions GET /api/v1/meta/schemas/user/linkedObjects List all Linked Object Definitions

CreateLinkedObjectDefinition

LinkedObject CreateLinkedObjectDefinition (LinkedObject linkedObject)

Create a Linked Object Definition

Creates a Linked Object definition

Example

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

namespace Example
{
    public class CreateLinkedObjectDefinitionExample
    {
        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 LinkedObjectApi(config);
            var linkedObject = new LinkedObject(); // LinkedObject | 

            try
            {
                // Create a Linked Object Definition
                LinkedObject result = apiInstance.CreateLinkedObjectDefinition(linkedObject);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling LinkedObjectApi.CreateLinkedObjectDefinition: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
linkedObject LinkedObject

Return type

LinkedObject

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 -
409 Conflict -
429 Too Many Requests -

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

DeleteLinkedObjectDefinition

void DeleteLinkedObjectDefinition (string linkedObjectName)

Delete a Linked Object Definition

Deletes the Linked Object definition specified by either the primary or associated name. The entire definition is removed, regardless of which name that you specify.

Example

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

namespace Example
{
    public class DeleteLinkedObjectDefinitionExample
    {
        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 LinkedObjectApi(config);
            var linkedObjectName = "linkedObjectName_example";  // string | Primary or Associated name

            try
            {
                // Delete a Linked Object Definition
                apiInstance.DeleteLinkedObjectDefinition(linkedObjectName);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling LinkedObjectApi.DeleteLinkedObjectDefinition: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
linkedObjectName string Primary or Associated name

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]

GetLinkedObjectDefinition

LinkedObject GetLinkedObjectDefinition (string linkedObjectName)

Retrieve a Linked Object Definition

Retrieves a Linked Object definition

Example

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

namespace Example
{
    public class GetLinkedObjectDefinitionExample
    {
        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 LinkedObjectApi(config);
            var linkedObjectName = "linkedObjectName_example";  // string | Primary or Associated name

            try
            {
                // Retrieve a Linked Object Definition
                LinkedObject result = apiInstance.GetLinkedObjectDefinition(linkedObjectName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling LinkedObjectApi.GetLinkedObjectDefinition: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
linkedObjectName string Primary or Associated name

Return type

LinkedObject

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]

ListLinkedObjectDefinitions

List<LinkedObject> ListLinkedObjectDefinitions ()

List all Linked Object Definitions

Lists all Linked Object definitions

Example

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

namespace Example
{
    public class ListLinkedObjectDefinitionsExample
    {
        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 LinkedObjectApi(config);

            try
            {
                // List all Linked Object Definitions
                List<LinkedObject> result = apiInstance.ListLinkedObjectDefinitions().ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling LinkedObjectApi.ListLinkedObjectDefinitions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<LinkedObject>

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]