1. Packages
  2. Okta Provider
  3. API Docs
  4. getUiSchema
Viewing docs for Okta v6.4.0
published on Saturday, Mar 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.getUiSchema

okta logo
Viewing docs for Okta v6.4.0
published on Saturday, Mar 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Use this data source to retrieve information about an Okta UI Schema.

    Example Usage

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

const example = okta.getUiSchema({
    id: "ui_schema_id",
});

    import pulumi
import pulumi_okta as okta

example = okta.get_ui_schema(id="ui_schema_id")

    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.LookupUiSchema(ctx, &okta.LookupUiSchemaArgs{
			Id: "ui_schema_id",
		}, nil)
		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 = Okta.GetUiSchema.Invoke(new()
    {
        Id = "ui_schema_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetUiSchemaArgs;
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) {
        final var example = OktaFunctions.getUiSchema(GetUiSchemaArgs.builder()
            .id("ui_schema_id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: okta:getUiSchema
      arguments:
        id: ui_schema_id

    Using getUiSchema

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUiSchema(args: GetUiSchemaArgs, opts?: InvokeOptions): Promise<GetUiSchemaResult>
function getUiSchemaOutput(args: GetUiSchemaOutputArgs, opts?: InvokeOptions): Output<GetUiSchemaResult>
    def get_ui_schema(id: Optional[str] = None,
                  ui_schema: Optional[GetUiSchemaUiSchema] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUiSchemaResult
def get_ui_schema_output(id: Optional[pulumi.Input[str]] = None,
                  ui_schema: Optional[pulumi.Input[GetUiSchemaUiSchemaArgs]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUiSchemaResult]
    func LookupUiSchema(ctx *Context, args *LookupUiSchemaArgs, opts ...InvokeOption) (*LookupUiSchemaResult, error)
func LookupUiSchemaOutput(ctx *Context, args *LookupUiSchemaOutputArgs, opts ...InvokeOption) LookupUiSchemaResultOutput

    > Note: This function is named LookupUiSchema in the Go SDK.

    public static class GetUiSchema 
{
    public static Task<GetUiSchemaResult> InvokeAsync(GetUiSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetUiSchemaResult> Invoke(GetUiSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUiSchemaResult> getUiSchema(GetUiSchemaArgs args, InvokeOptions options)
public static Output<GetUiSchemaResult> getUiSchema(GetUiSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:index/getUiSchema:getUiSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID property of an UI Schema.
    UiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    Id string
    The ID property of an UI Schema.
    UiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    id String
    The ID property of an UI Schema.
    uiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    id string
    The ID property of an UI Schema.
    uiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    id str
    The ID property of an UI Schema.
    ui_schema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    id String
    The ID property of an UI Schema.
    uiSchema Property Map
    • (Object) Representation of a resource.

    getUiSchema Result

    The following output properties are available:

    Created string
    Timestamp when the UI Schema was created. (ISO 86001).
    Id string
    The ID property of an UI Schema.
    LastUpdated string
    Timestamp when the UI Schema was last modified (ISO 86001).
    UiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    Created string
    Timestamp when the UI Schema was created. (ISO 86001).
    Id string
    The ID property of an UI Schema.
    LastUpdated string
    Timestamp when the UI Schema was last modified (ISO 86001).
    UiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    created String
    Timestamp when the UI Schema was created. (ISO 86001).
    id String
    The ID property of an UI Schema.
    lastUpdated String
    Timestamp when the UI Schema was last modified (ISO 86001).
    uiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    created string
    Timestamp when the UI Schema was created. (ISO 86001).
    id string
    The ID property of an UI Schema.
    lastUpdated string
    Timestamp when the UI Schema was last modified (ISO 86001).
    uiSchema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    created str
    Timestamp when the UI Schema was created. (ISO 86001).
    id str
    The ID property of an UI Schema.
    last_updated str
    Timestamp when the UI Schema was last modified (ISO 86001).
    ui_schema GetUiSchemaUiSchema
    • (Object) Representation of a resource.
    created String
    Timestamp when the UI Schema was created. (ISO 86001).
    id String
    The ID property of an UI Schema.
    lastUpdated String
    Timestamp when the UI Schema was last modified (ISO 86001).
    uiSchema Property Map
    • (Object) Representation of a resource.

    Supporting Types

    GetUiSchemaUiSchema

    ButtonLabel string
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    Label string
    Specifies the label at the top of the enrollment form under the logo.
    Type string
    Specifies the type of layout.
    Elements List<GetUiSchemaUiSchemaElement>
    ButtonLabel string
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    Label string
    Specifies the label at the top of the enrollment form under the logo.
    Type string
    Specifies the type of layout.
    Elements []GetUiSchemaUiSchemaElement
    buttonLabel String
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    label String
    Specifies the label at the top of the enrollment form under the logo.
    type String
    Specifies the type of layout.
    elements List<GetUiSchemaUiSchemaElement>
    buttonLabel string
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    label string
    Specifies the label at the top of the enrollment form under the logo.
    type string
    Specifies the type of layout.
    elements GetUiSchemaUiSchemaElement[]
    button_label str
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    label str
    Specifies the label at the top of the enrollment form under the logo.
    type str
    Specifies the type of layout.
    elements Sequence[GetUiSchemaUiSchemaElement]
    buttonLabel String
    Specifies the button label for the Submit button at the bottom of the enrollment form.
    label String
    Specifies the label at the top of the enrollment form under the logo.
    type String
    Specifies the type of layout.
    elements List<Property Map>

    GetUiSchemaUiSchemaElement

    Label string
    Label name for the UI element.
    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.
    Type string
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    Options GetUiSchemaUiSchemaElementOptions
    UI Schema element options object.
    Label string
    Label name for the UI element.
    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.
    Type string
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    Options GetUiSchemaUiSchemaElementOptions
    UI Schema element options object.
    label String
    Label name for the UI element.
    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.
    type String
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    options GetUiSchemaUiSchemaElementOptions
    UI Schema element options object.
    label string
    Label name for the UI element.
    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.
    type string
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    options GetUiSchemaUiSchemaElementOptions
    UI Schema element options object.
    label str
    Label name for the UI element.
    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.
    type str
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    options GetUiSchemaUiSchemaElementOptions
    UI Schema element options object.
    label String
    Label name for the UI element.
    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.
    type String
    Specifies the relationship between this input element and scope. The Control value specifies that this input controls the value represented by scope.
    options Property Map
    UI Schema element options object.

    GetUiSchemaUiSchemaElementOptions

    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.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.4.0
    published on Saturday, Mar 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.