UiSchema

Okta v6.2.1, Dec 29 25

Okta v6.2.1 published on Monday, Dec 29, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Okta v6.2.1 published on Monday, Dec 29, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.UiSchema("example", {uiSchema: {
    buttonLabel: "submit",
    type: "Group",
    elements: [{
        scope: "#/properties/lastName",
    }],
}});

import pulumi
import pulumi_okta as okta

example = okta.UiSchema("example", ui_schema={
    "button_label": "submit",
    "type": "Group",
    "elements": [{
        "scope": "#/properties/lastName",
    }],
})

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewUiSchema(ctx, "example", &okta.UiSchemaArgs{
			UiSchema: &okta.UiSchemaUiSchemaArgs{
				ButtonLabel: pulumi.String("submit"),
				Type:        pulumi.String("Group"),
				Elements: okta.UiSchemaUiSchemaElementArray{
					&okta.UiSchemaUiSchemaElementArgs{
						Scope: pulumi.String("#/properties/lastName"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.UiSchema("example", new()
    {
        UiSchemaName = new Okta.Inputs.UiSchemaUiSchemaArgs
        {
            ButtonLabel = "submit",
            Type = "Group",
            Elements = new[]
            {
                new Okta.Inputs.UiSchemaUiSchemaElementArgs
                {
                    Scope = "#/properties/lastName",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.UiSchema;
import com.pulumi.okta.UiSchemaArgs;
import com.pulumi.okta.inputs.UiSchemaUiSchemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UiSchema("example", UiSchemaArgs.builder()
            .uiSchema(UiSchemaUiSchemaArgs.builder()
                .buttonLabel("submit")
                .type("Group")
                .elements(UiSchemaUiSchemaElementArgs.builder()
                    .scope("#/properties/lastName")
                    .build())
                .build())
            .build());

    }
}

resources:
  example:
    type: okta:UiSchema
    properties:
      uiSchema:
        buttonLabel: submit
        type: Group
        elements:
          - scope: '#/properties/lastName'

Create UiSchema Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UiSchema(name: string, args?: UiSchemaArgs, opts?: CustomResourceOptions);

@overload
def UiSchema(resource_name: str,
             args: Optional[UiSchemaArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def UiSchema(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ui_schema: Optional[UiSchemaUiSchemaArgs] = None)

func NewUiSchema(ctx *Context, name string, args *UiSchemaArgs, opts ...ResourceOption) (*UiSchema, error)

public UiSchema(string name, UiSchemaArgs? args = null, CustomResourceOptions? opts = null)

public UiSchema(String name, UiSchemaArgs args)
public UiSchema(String name, UiSchemaArgs args, CustomResourceOptions options)

type: okta:UiSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UiSchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UiSchemaArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UiSchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UiSchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UiSchemaArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var uiSchemaResource = new Okta.UiSchema("uiSchemaResource", new()
{
    UiSchemaName = new Okta.Inputs.UiSchemaUiSchemaArgs
    {
        ButtonLabel = "string",
        Elements = new[]
        {
            new Okta.Inputs.UiSchemaUiSchemaElementArgs
            {
                Scope = "string",
                Label = "string",
                Options = new Okta.Inputs.UiSchemaUiSchemaElementOptionsArgs
                {
                    Format = "string",
                },
                Type = "string",
            },
        },
        Label = "string",
        Type = "string",
    },
});

example, err := okta.NewUiSchema(ctx, "uiSchemaResource", &okta.UiSchemaArgs{
	UiSchema: &okta.UiSchemaUiSchemaArgs{
		ButtonLabel: pulumi.String("string"),
		Elements: okta.UiSchemaUiSchemaElementArray{
			&okta.UiSchemaUiSchemaElementArgs{
				Scope: pulumi.String("string"),
				Label: pulumi.String("string"),
				Options: &okta.UiSchemaUiSchemaElementOptionsArgs{
					Format: pulumi.String("string"),
				},
				Type: pulumi.String("string"),
			},
		},
		Label: pulumi.String("string"),
		Type:  pulumi.String("string"),
	},
})

var uiSchemaResource = new UiSchema("uiSchemaResource", UiSchemaArgs.builder()
    .uiSchema(UiSchemaUiSchemaArgs.builder()
        .buttonLabel("string")
        .elements(UiSchemaUiSchemaElementArgs.builder()
            .scope("string")
            .label("string")
            .options(UiSchemaUiSchemaElementOptionsArgs.builder()
                .format("string")
                .build())
            .type("string")
            .build())
        .label("string")
        .type("string")
        .build())
    .build());

ui_schema_resource = okta.UiSchema("uiSchemaResource", ui_schema={
    "button_label": "string",
    "elements": [{
        "scope": "string",
        "label": "string",
        "options": {
            "format": "string",
        },
        "type": "string",
    }],
    "label": "string",
    "type": "string",
})

const uiSchemaResource = new okta.UiSchema("uiSchemaResource", {uiSchema: {
    buttonLabel: "string",
    elements: [{
        scope: "string",
        label: "string",
        options: {
            format: "string",
        },
        type: "string",
    }],
    label: "string",
    type: "string",
}});

type: okta:UiSchema
properties:
    uiSchema:
        buttonLabel: string
        elements:
            - label: string
              options:
                format: string
              scope: string
              type: string
        label: string
        type: string

UiSchema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UiSchema resource accepts the following input properties:

UiSchemaName UiSchemaUiSchema: Properties of the UI schema.

UiSchema UiSchemaUiSchemaArgs: Properties of the UI schema.

uiSchema UiSchemaUiSchema: Properties of the UI schema.

uiSchema UiSchemaUiSchema: Properties of the UI schema.

ui_schema UiSchemaUiSchemaArgs: Properties of the UI schema.

uiSchema Property Map: Properties of the UI schema.

Outputs

All input properties are implicitly available as output properties. Additionally, the UiSchema resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing UiSchema Resource

Get an existing UiSchema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UiSchemaState, opts?: CustomResourceOptions): UiSchema

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ui_schema: Optional[UiSchemaUiSchemaArgs] = None) -> UiSchema

func GetUiSchema(ctx *Context, name string, id IDInput, state *UiSchemaState, opts ...ResourceOption) (*UiSchema, error)

public static UiSchema Get(string name, Input<string> id, UiSchemaState? state, CustomResourceOptions? opts = null)

public static UiSchema get(String name, Output<String> id, UiSchemaState state, CustomResourceOptions options)

resources:  _:    type: okta:UiSchema    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

UiSchemaName UiSchemaUiSchema: Properties of the UI schema.

UiSchema UiSchemaUiSchemaArgs: Properties of the UI schema.

uiSchema UiSchemaUiSchema: Properties of the UI schema.

uiSchema UiSchemaUiSchema: Properties of the UI schema.

ui_schema UiSchemaUiSchemaArgs: Properties of the UI schema.

uiSchema Property Map: Properties of the UI schema.

Supporting Types

UiSchemaUiSchema, UiSchemaUiSchemaArgs

ButtonLabel string: Specifies the button label for the Submit button at the bottom of the enrollment form.
Elements List<UiSchemaUiSchemaElement>
Label string: Specifies the label at the top of the enrollment form under the logo.
Type string: Specifies the type of layout.

ButtonLabel string: Specifies the button label for the Submit button at the bottom of the enrollment form.
Elements []UiSchemaUiSchemaElement
Label string: Specifies the label at the top of the enrollment form under the logo.
Type string: Specifies the type of layout.

buttonLabel String: Specifies the button label for the Submit button at the bottom of the enrollment form.
elements List<UiSchemaUiSchemaElement>
label String: Specifies the label at the top of the enrollment form under the logo.
type String: Specifies the type of layout.

buttonLabel string: Specifies the button label for the Submit button at the bottom of the enrollment form.
elements UiSchemaUiSchemaElement[]
label string: Specifies the label at the top of the enrollment form under the logo.
type string: Specifies the type of layout.

button_label str: Specifies the button label for the Submit button at the bottom of the enrollment form.
elements Sequence[UiSchemaUiSchemaElement]
label str: Specifies the label at the top of the enrollment form under the logo.
type str: Specifies the type of layout.

buttonLabel String: Specifies the button label for the Submit button at the bottom of the enrollment form.
elements List<Property Map>
label String: Specifies the label at the top of the enrollment form under the logo.
type String: Specifies the type of layout.

UiSchemaUiSchemaElement, UiSchemaUiSchemaElementArgs

Scope string: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
Label string: Label name for the UI element.
Options UiSchemaUiSchemaElementOptions: UI Schema element options object.
Type string: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

Scope string: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
Label string: Label name for the UI element.
Options UiSchemaUiSchemaElementOptions: UI Schema element options object.
Type string: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

scope String: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
label String: Label name for the UI element.
options UiSchemaUiSchemaElementOptions: UI Schema element options object.
type String: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

scope string: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
label string: Label name for the UI element.
options UiSchemaUiSchemaElementOptions: UI Schema element options object.
type string: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

scope str: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
label str: Label name for the UI element.
options UiSchemaUiSchemaElementOptions: UI Schema element options object.
type str: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

scope String: Specifies the property bound to the input field. It must follow the format #/properties/PROPERTY_NAME where PROPERTY_NAME is a variable name for an attribute in profile editor.
label String: Label name for the UI element.
options Property Map: UI Schema element options object.
type String: Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.

UiSchemaUiSchemaElementOptions, UiSchemaUiSchemaElementOptionsArgs

Format string: Specifies how the input appears.

Format string: Specifies how the input appears.

format String: Specifies how the input appears.

format string: Specifies how the input appears.

format str: Specifies how the input appears.

format String: Specifies how the input appears.

Import

$ pulumi import okta:index/uiSchema:UiSchema example <ui_schema_id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Okta pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

Okta v6.2.1 published on Monday, Dec 29, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

okta.UiSchema

On this page

On this page

Example Usage

Create UiSchema Resource

Constructor syntax

Parameters

Constructor example

UiSchema Resource Properties

Inputs

Outputs

Look up Existing UiSchema Resource

Supporting Types

UiSchemaUiSchema, UiSchemaUiSchemaArgs

UiSchemaUiSchemaElement, UiSchemaUiSchemaElementArgs

UiSchemaUiSchemaElementOptions, UiSchemaUiSchemaElementOptionsArgs

Import

Package Details

On this page

On this page