Skip to content

UISchemaApi.md

Latest commit

 

History

History
406 lines (313 loc) · 11.7 KB

UISchemaApi.md

File metadata and controls

406 lines (313 loc) · 11.7 KB
Raw

Okta.Sdk.Api.UISchemaApi

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

Method HTTP request Description
CreateUISchema POST /api/v1/meta/uischemas Create a UI schema
DeleteUISchemas DELETE /api/v1/meta/uischemas/{id} Delete a UI schema
GetUISchema GET /api/v1/meta/uischemas/{id} Retrieve a UI schema
ListUISchemas GET /api/v1/meta/uischemas List all UI schemas
ReplaceUISchemas PUT /api/v1/meta/uischemas/{id} Replace a UI schema

CreateUISchema

UISchemasResponseObject CreateUISchema (CreateUISchema uischemabody)

Create a UI schema

Creates an input for an enrollment form

Example

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

namespace Example
{
    public class CreateUISchemaExample
    {
        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 UISchemaApi(config);
            var uischemabody = new CreateUISchema(); // CreateUISchema | 

            try
            {
                // Create a UI schema
                UISchemasResponseObject result = apiInstance.CreateUISchema(uischemabody);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UISchemaApi.CreateUISchema: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
uischemabody CreateUISchema

Return type

UISchemasResponseObject

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]

DeleteUISchemas

void DeleteUISchemas (string id)

Delete a UI schema

Deletes a UI Schema 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 DeleteUISchemasExample
    {
        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 UISchemaApi(config);
            var id = uis4a7liocgcRgcxZ0g7;  // string | The unique ID of the UI Schema

            try
            {
                // Delete a UI schema
                apiInstance.DeleteUISchemas(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UISchemaApi.DeleteUISchemas: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The unique ID of the UI Schema

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

GetUISchema

UISchemasResponseObject GetUISchema (string id)

Retrieve a UI schema

Retrieves a UI Schema 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 GetUISchemaExample
    {
        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 UISchemaApi(config);
            var id = uis4a7liocgcRgcxZ0g7;  // string | The unique ID of the UI Schema

            try
            {
                // Retrieve a UI schema
                UISchemasResponseObject result = apiInstance.GetUISchema(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UISchemaApi.GetUISchema: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The unique ID of the UI Schema

Return type

UISchemasResponseObject

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]

ListUISchemas

List<UISchemasResponseObject> ListUISchemas ()

List all UI schemas

Lists all UI Schemas in your 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 ListUISchemasExample
    {
        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 UISchemaApi(config);

            try
            {
                // List all UI schemas
                List<UISchemasResponseObject> result = apiInstance.ListUISchemas().ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UISchemaApi.ListUISchemas: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<UISchemasResponseObject>

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]

ReplaceUISchemas

UISchemasResponseObject ReplaceUISchemas (string id, UpdateUISchema updateUISchemaBody)

Replace a UI schema

Replaces a UI Schema 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 ReplaceUISchemasExample
    {
        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 UISchemaApi(config);
            var id = uis4a7liocgcRgcxZ0g7;  // string | The unique ID of the UI Schema
            var updateUISchemaBody = new UpdateUISchema(); // UpdateUISchema | 

            try
            {
                // Replace a UI schema
                UISchemasResponseObject result = apiInstance.ReplaceUISchemas(id, updateUISchemaBody);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UISchemaApi.ReplaceUISchemas: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The unique ID of the UI Schema
updateUISchemaBody UpdateUISchema

Return type

UISchemasResponseObject

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]