Okta v4.16.0, Apr 9 25

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi

okta.AppUserSchemaProperty

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new okta.AppUserSchemaProperty("example", {
    appId: "<app id>",
    index: "customPropertyName",
    title: "customPropertyName",
    type: "string",
    description: "My custom property name",
    master: "OKTA",
    scope: "SELF",
    arrayEnums: [
        "1",
        "2",
    ],
    arrayOneOfs: [
        {
            "const": "1",
            title: "one",
        },
        {
            "const": "2",
            title: "two",
        },
    ],
});

import pulumi
import pulumi_okta as okta

example = okta.AppUserSchemaProperty("example",
    app_id="<app id>",
    index="customPropertyName",
    title="customPropertyName",
    type="string",
    description="My custom property name",
    master="OKTA",
    scope="SELF",
    array_enums=[
        "1",
        "2",
    ],
    array_one_ofs=[
        {
            "const": "1",
            "title": "one",
        },
        {
            "const": "2",
            "title": "two",
        },
    ])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewAppUserSchemaProperty(ctx, "example", &okta.AppUserSchemaPropertyArgs{
			AppId:       pulumi.String("<app id>"),
			Index:       pulumi.String("customPropertyName"),
			Title:       pulumi.String("customPropertyName"),
			Type:        pulumi.String("string"),
			Description: pulumi.String("My custom property name"),
			Master:      pulumi.String("OKTA"),
			Scope:       pulumi.String("SELF"),
			ArrayEnums: pulumi.StringArray{
				pulumi.String("1"),
				pulumi.String("2"),
			},
			ArrayOneOfs: okta.AppUserSchemaPropertyArrayOneOfArray{
				&okta.AppUserSchemaPropertyArrayOneOfArgs{
					Const: pulumi.String("1"),
					Title: pulumi.String("one"),
				},
				&okta.AppUserSchemaPropertyArrayOneOfArgs{
					Const: pulumi.String("2"),
					Title: pulumi.String("two"),
				},
			},
		})
		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.AppUserSchemaProperty("example", new()
    {
        AppId = "<app id>",
        Index = "customPropertyName",
        Title = "customPropertyName",
        Type = "string",
        Description = "My custom property name",
        Master = "OKTA",
        Scope = "SELF",
        ArrayEnums = new[]
        {
            "1",
            "2",
        },
        ArrayOneOfs = new[]
        {
            new Okta.Inputs.AppUserSchemaPropertyArrayOneOfArgs
            {
                Const = "1",
                Title = "one",
            },
            new Okta.Inputs.AppUserSchemaPropertyArrayOneOfArgs
            {
                Const = "2",
                Title = "two",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.AppUserSchemaProperty;
import com.pulumi.okta.AppUserSchemaPropertyArgs;
import com.pulumi.okta.inputs.AppUserSchemaPropertyArrayOneOfArgs;
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 AppUserSchemaProperty("example", AppUserSchemaPropertyArgs.builder()
            .appId("<app id>")
            .index("customPropertyName")
            .title("customPropertyName")
            .type("string")
            .description("My custom property name")
            .master("OKTA")
            .scope("SELF")
            .arrayEnums(            
                "1",
                "2")
            .arrayOneOfs(            
                AppUserSchemaPropertyArrayOneOfArgs.builder()
                    .const_("1")
                    .title("one")
                    .build(),
                AppUserSchemaPropertyArrayOneOfArgs.builder()
                    .const_("2")
                    .title("two")
                    .build())
            .build());

    }
}

resources:
  example:
    type: okta:AppUserSchemaProperty
    properties:
      appId: <app id>
      index: customPropertyName
      title: customPropertyName
      type: string
      description: My custom property name
      master: OKTA
      scope: SELF
      arrayEnums:
        - '1'
        - '2'
      arrayOneOfs:
        - const: '1'
          title: one
        - const: '2'
          title: two

Create AppUserSchemaProperty Resource

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

new AppUserSchemaProperty(name: string, args: AppUserSchemaPropertyArgs, opts?: CustomResourceOptions);

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

@overload
def AppUserSchemaProperty(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          index: Optional[str] = None,
                          type: Optional[str] = None,
                          title: Optional[str] = None,
                          app_id: Optional[str] = None,
                          max_length: Optional[int] = None,
                          permissions: Optional[str] = None,
                          external_name: Optional[str] = None,
                          external_namespace: Optional[str] = None,
                          description: Optional[str] = None,
                          master: Optional[str] = None,
                          array_type: Optional[str] = None,
                          min_length: Optional[int] = None,
                          one_ofs: Optional[Sequence[AppUserSchemaPropertyOneOfArgs]] = None,
                          enums: Optional[Sequence[str]] = None,
                          required: Optional[bool] = None,
                          scope: Optional[str] = None,
                          array_one_ofs: Optional[Sequence[AppUserSchemaPropertyArrayOneOfArgs]] = None,
                          array_enums: Optional[Sequence[str]] = None,
                          union: Optional[bool] = None,
                          unique: Optional[str] = None,
                          user_type: Optional[str] = None)

func NewAppUserSchemaProperty(ctx *Context, name string, args AppUserSchemaPropertyArgs, opts ...ResourceOption) (*AppUserSchemaProperty, error)

public AppUserSchemaProperty(string name, AppUserSchemaPropertyArgs args, CustomResourceOptions? opts = null)

public AppUserSchemaProperty(String name, AppUserSchemaPropertyArgs args)
public AppUserSchemaProperty(String name, AppUserSchemaPropertyArgs args, CustomResourceOptions options)

type: okta:AppUserSchemaProperty
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 AppUserSchemaPropertyArgs: 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 AppUserSchemaPropertyArgs: 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 AppUserSchemaPropertyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args AppUserSchemaPropertyArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var appUserSchemaPropertyResource = new Okta.AppUserSchemaProperty("appUserSchemaPropertyResource", new()
{
    Index = "string",
    Type = "string",
    Title = "string",
    AppId = "string",
    MaxLength = 0,
    Permissions = "string",
    ExternalName = "string",
    ExternalNamespace = "string",
    Description = "string",
    Master = "string",
    ArrayType = "string",
    MinLength = 0,
    OneOfs = new[]
    {
        new Okta.Inputs.AppUserSchemaPropertyOneOfArgs
        {
            Const = "string",
            Title = "string",
        },
    },
    Enums = new[]
    {
        "string",
    },
    Required = false,
    Scope = "string",
    ArrayOneOfs = new[]
    {
        new Okta.Inputs.AppUserSchemaPropertyArrayOneOfArgs
        {
            Const = "string",
            Title = "string",
        },
    },
    ArrayEnums = new[]
    {
        "string",
    },
    Union = false,
    Unique = "string",
    UserType = "string",
});

example, err := okta.NewAppUserSchemaProperty(ctx, "appUserSchemaPropertyResource", &okta.AppUserSchemaPropertyArgs{
	Index:             pulumi.String("string"),
	Type:              pulumi.String("string"),
	Title:             pulumi.String("string"),
	AppId:             pulumi.String("string"),
	MaxLength:         pulumi.Int(0),
	Permissions:       pulumi.String("string"),
	ExternalName:      pulumi.String("string"),
	ExternalNamespace: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Master:            pulumi.String("string"),
	ArrayType:         pulumi.String("string"),
	MinLength:         pulumi.Int(0),
	OneOfs: okta.AppUserSchemaPropertyOneOfArray{
		&okta.AppUserSchemaPropertyOneOfArgs{
			Const: pulumi.String("string"),
			Title: pulumi.String("string"),
		},
	},
	Enums: pulumi.StringArray{
		pulumi.String("string"),
	},
	Required: pulumi.Bool(false),
	Scope:    pulumi.String("string"),
	ArrayOneOfs: okta.AppUserSchemaPropertyArrayOneOfArray{
		&okta.AppUserSchemaPropertyArrayOneOfArgs{
			Const: pulumi.String("string"),
			Title: pulumi.String("string"),
		},
	},
	ArrayEnums: pulumi.StringArray{
		pulumi.String("string"),
	},
	Union:    pulumi.Bool(false),
	Unique:   pulumi.String("string"),
	UserType: pulumi.String("string"),
})

var appUserSchemaPropertyResource = new AppUserSchemaProperty("appUserSchemaPropertyResource", AppUserSchemaPropertyArgs.builder()
    .index("string")
    .type("string")
    .title("string")
    .appId("string")
    .maxLength(0)
    .permissions("string")
    .externalName("string")
    .externalNamespace("string")
    .description("string")
    .master("string")
    .arrayType("string")
    .minLength(0)
    .oneOfs(AppUserSchemaPropertyOneOfArgs.builder()
        .const_("string")
        .title("string")
        .build())
    .enums("string")
    .required(false)
    .scope("string")
    .arrayOneOfs(AppUserSchemaPropertyArrayOneOfArgs.builder()
        .const_("string")
        .title("string")
        .build())
    .arrayEnums("string")
    .union(false)
    .unique("string")
    .userType("string")
    .build());

app_user_schema_property_resource = okta.AppUserSchemaProperty("appUserSchemaPropertyResource",
    index="string",
    type="string",
    title="string",
    app_id="string",
    max_length=0,
    permissions="string",
    external_name="string",
    external_namespace="string",
    description="string",
    master="string",
    array_type="string",
    min_length=0,
    one_ofs=[{
        "const": "string",
        "title": "string",
    }],
    enums=["string"],
    required=False,
    scope="string",
    array_one_ofs=[{
        "const": "string",
        "title": "string",
    }],
    array_enums=["string"],
    union=False,
    unique="string",
    user_type="string")

const appUserSchemaPropertyResource = new okta.AppUserSchemaProperty("appUserSchemaPropertyResource", {
    index: "string",
    type: "string",
    title: "string",
    appId: "string",
    maxLength: 0,
    permissions: "string",
    externalName: "string",
    externalNamespace: "string",
    description: "string",
    master: "string",
    arrayType: "string",
    minLength: 0,
    oneOfs: [{
        "const": "string",
        title: "string",
    }],
    enums: ["string"],
    required: false,
    scope: "string",
    arrayOneOfs: [{
        "const": "string",
        title: "string",
    }],
    arrayEnums: ["string"],
    union: false,
    unique: "string",
    userType: "string",
});

type: okta:AppUserSchemaProperty
properties:
    appId: string
    arrayEnums:
        - string
    arrayOneOfs:
        - const: string
          title: string
    arrayType: string
    description: string
    enums:
        - string
    externalName: string
    externalNamespace: string
    index: string
    master: string
    maxLength: 0
    minLength: 0
    oneOfs:
        - const: string
          title: string
    permissions: string
    required: false
    scope: string
    title: string
    type: string
    union: false
    unique: string
    userType: string

AppUserSchemaProperty 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 AppUserSchemaProperty resource accepts the following input properties:

AppId string

The Application's ID the user custom schema property should be assigned to.

Index string

Subschema unique string identifier

Title string

Subschema title (display name)

Type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

ArrayEnums List<string>

Array of values that an array property's items can be set to.

ArrayOneOfs List<AppUserSchemaPropertyArrayOneOf>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

ArrayType string

The type of the array elements if type is set to array

Description string

The description of the user schema property.

Enums List<string>

Array of values a primitive property can be set to. See array_enum for arrays.

ExternalName string

External name of the user schema property.

ExternalNamespace string

External namespace of the user schema property.

Master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

MaxLength int

The maximum length of the user property value. Only applies to type string

MinLength int

The minimum length of the user property value. Only applies to type string

OneOfs List<AppUserSchemaPropertyOneOf>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

Permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

Required bool

Whether the subschema is required

Scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

Union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

Unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

UserType string

User type ID. By default, it is default

AppId string

The Application's ID the user custom schema property should be assigned to.

Index string

Subschema unique string identifier

Title string

Subschema title (display name)

Type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

ArrayEnums []string

Array of values that an array property's items can be set to.

ArrayOneOfs []AppUserSchemaPropertyArrayOneOfArgs

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

ArrayType string

The type of the array elements if type is set to array

Description string

The description of the user schema property.

Enums []string

Array of values a primitive property can be set to. See array_enum for arrays.

ExternalName string

External name of the user schema property.

ExternalNamespace string

External namespace of the user schema property.

Master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

MaxLength int

The maximum length of the user property value. Only applies to type string

MinLength int

The minimum length of the user property value. Only applies to type string

OneOfs []AppUserSchemaPropertyOneOfArgs

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

Permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

Required bool

Whether the subschema is required

Scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

Union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

Unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

UserType string

User type ID. By default, it is default

appId String

The Application's ID the user custom schema property should be assigned to.

index String

Subschema unique string identifier

title String

Subschema title (display name)

type String

The type of the schema property. It can be string, boolean, number, integer, array, or object

arrayEnums List<String>

Array of values that an array property's items can be set to.

arrayOneOfs List<AppUserSchemaPropertyArrayOneOf>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType String

The type of the array elements if type is set to array

description String

The description of the user schema property.

enums List<String>

Array of values a primitive property can be set to. See array_enum for arrays.

externalName String

External name of the user schema property.

externalNamespace String

External namespace of the user schema property.

master String

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength Integer

The maximum length of the user property value. Only applies to type string

minLength Integer

The minimum length of the user property value. Only applies to type string

oneOfs List<AppUserSchemaPropertyOneOf>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions String

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required Boolean

Whether the subschema is required

scope String

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

union Boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique String

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType String

User type ID. By default, it is default

appId string

The Application's ID the user custom schema property should be assigned to.

index string

Subschema unique string identifier

title string

Subschema title (display name)

type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

arrayEnums string[]

Array of values that an array property's items can be set to.

arrayOneOfs AppUserSchemaPropertyArrayOneOf[]

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType string

The type of the array elements if type is set to array

description string

The description of the user schema property.

enums string[]

Array of values a primitive property can be set to. See array_enum for arrays.

externalName string

External name of the user schema property.

externalNamespace string

External namespace of the user schema property.

master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength number

The maximum length of the user property value. Only applies to type string

minLength number

The minimum length of the user property value. Only applies to type string

oneOfs AppUserSchemaPropertyOneOf[]

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required boolean

Whether the subschema is required

scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

union boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType string

User type ID. By default, it is default

app_id str

The Application's ID the user custom schema property should be assigned to.

index str

Subschema unique string identifier

title str

Subschema title (display name)

type str

The type of the schema property. It can be string, boolean, number, integer, array, or object

array_enums Sequence[str]

Array of values that an array property's items can be set to.

array_one_ofs Sequence[AppUserSchemaPropertyArrayOneOfArgs]

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

array_type str

The type of the array elements if type is set to array

description str

The description of the user schema property.

enums Sequence[str]

Array of values a primitive property can be set to. See array_enum for arrays.

external_name str

External name of the user schema property.

external_namespace str

External namespace of the user schema property.

master str

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

max_length int

The maximum length of the user property value. Only applies to type string

min_length int

The minimum length of the user property value. Only applies to type string

one_ofs Sequence[AppUserSchemaPropertyOneOfArgs]

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions str

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required bool

Whether the subschema is required

scope str

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique str

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

user_type str

User type ID. By default, it is default

appId String

The Application's ID the user custom schema property should be assigned to.

index String

Subschema unique string identifier

title String

Subschema title (display name)

type String

The type of the schema property. It can be string, boolean, number, integer, array, or object

arrayEnums List<String>

Array of values that an array property's items can be set to.

arrayOneOfs List<Property Map>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType String

The type of the array elements if type is set to array

description String

The description of the user schema property.

enums List<String>

Array of values a primitive property can be set to. See array_enum for arrays.

externalName String

External name of the user schema property.

externalNamespace String

External namespace of the user schema property.

master String

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength Number

The maximum length of the user property value. Only applies to type string

minLength Number

The minimum length of the user property value. Only applies to type string

oneOfs List<Property Map>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions String

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required Boolean

Whether the subschema is required

scope String

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

union Boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique String

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType String

User type ID. By default, it is default

Outputs

All input properties are implicitly available as output properties. Additionally, the AppUserSchemaProperty 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 AppUserSchemaProperty Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        array_enums: Optional[Sequence[str]] = None,
        array_one_ofs: Optional[Sequence[AppUserSchemaPropertyArrayOneOfArgs]] = None,
        array_type: Optional[str] = None,
        description: Optional[str] = None,
        enums: Optional[Sequence[str]] = None,
        external_name: Optional[str] = None,
        external_namespace: Optional[str] = None,
        index: Optional[str] = None,
        master: Optional[str] = None,
        max_length: Optional[int] = None,
        min_length: Optional[int] = None,
        one_ofs: Optional[Sequence[AppUserSchemaPropertyOneOfArgs]] = None,
        permissions: Optional[str] = None,
        required: Optional[bool] = None,
        scope: Optional[str] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        union: Optional[bool] = None,
        unique: Optional[str] = None,
        user_type: Optional[str] = None) -> AppUserSchemaProperty

func GetAppUserSchemaProperty(ctx *Context, name string, id IDInput, state *AppUserSchemaPropertyState, opts ...ResourceOption) (*AppUserSchemaProperty, error)

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

public static AppUserSchemaProperty get(String name, Output<String> id, AppUserSchemaPropertyState state, CustomResourceOptions options)

resources:  _:    type: okta:AppUserSchemaProperty    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:

AppId string

The Application's ID the user custom schema property should be assigned to.

ArrayEnums List<string>

Array of values that an array property's items can be set to.

ArrayOneOfs List<AppUserSchemaPropertyArrayOneOf>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

ArrayType string

The type of the array elements if type is set to array

Description string

The description of the user schema property.

Enums List<string>

Array of values a primitive property can be set to. See array_enum for arrays.

ExternalName string

External name of the user schema property.

ExternalNamespace string

External namespace of the user schema property.

Index string

Subschema unique string identifier

Master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

MaxLength int

The maximum length of the user property value. Only applies to type string

MinLength int

The minimum length of the user property value. Only applies to type string

OneOfs List<AppUserSchemaPropertyOneOf>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

Permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

Required bool

Whether the subschema is required

Scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

Title string

Subschema title (display name)

Type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

Union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

Unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

UserType string

User type ID. By default, it is default

AppId string

The Application's ID the user custom schema property should be assigned to.

ArrayEnums []string

Array of values that an array property's items can be set to.

ArrayOneOfs []AppUserSchemaPropertyArrayOneOfArgs

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

ArrayType string

The type of the array elements if type is set to array

Description string

The description of the user schema property.

Enums []string

Array of values a primitive property can be set to. See array_enum for arrays.

ExternalName string

External name of the user schema property.

ExternalNamespace string

External namespace of the user schema property.

Index string

Subschema unique string identifier

Master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

MaxLength int

The maximum length of the user property value. Only applies to type string

MinLength int

The minimum length of the user property value. Only applies to type string

OneOfs []AppUserSchemaPropertyOneOfArgs

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

Permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

Required bool

Whether the subschema is required

Scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

Title string

Subschema title (display name)

Type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

Union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

Unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

UserType string

User type ID. By default, it is default

appId String

The Application's ID the user custom schema property should be assigned to.

arrayEnums List<String>

Array of values that an array property's items can be set to.

arrayOneOfs List<AppUserSchemaPropertyArrayOneOf>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType String

The type of the array elements if type is set to array

description String

The description of the user schema property.

enums List<String>

Array of values a primitive property can be set to. See array_enum for arrays.

externalName String

External name of the user schema property.

externalNamespace String

External namespace of the user schema property.

index String

Subschema unique string identifier

master String

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength Integer

The maximum length of the user property value. Only applies to type string

minLength Integer

The minimum length of the user property value. Only applies to type string

oneOfs List<AppUserSchemaPropertyOneOf>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions String

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required Boolean

Whether the subschema is required

scope String

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

title String

Subschema title (display name)

type String

The type of the schema property. It can be string, boolean, number, integer, array, or object

union Boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique String

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType String

User type ID. By default, it is default

appId string

The Application's ID the user custom schema property should be assigned to.

arrayEnums string[]

Array of values that an array property's items can be set to.

arrayOneOfs AppUserSchemaPropertyArrayOneOf[]

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType string

The type of the array elements if type is set to array

description string

The description of the user schema property.

enums string[]

Array of values a primitive property can be set to. See array_enum for arrays.

externalName string

External name of the user schema property.

externalNamespace string

External namespace of the user schema property.

index string

Subschema unique string identifier

master string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength number

The maximum length of the user property value. Only applies to type string

minLength number

The minimum length of the user property value. Only applies to type string

oneOfs AppUserSchemaPropertyOneOf[]

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required boolean

Whether the subschema is required

scope string

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

title string

Subschema title (display name)

type string

The type of the schema property. It can be string, boolean, number, integer, array, or object

union boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique string

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType string

User type ID. By default, it is default

app_id str

The Application's ID the user custom schema property should be assigned to.

array_enums Sequence[str]

Array of values that an array property's items can be set to.

array_one_ofs Sequence[AppUserSchemaPropertyArrayOneOfArgs]

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

array_type str

The type of the array elements if type is set to array

description str

The description of the user schema property.

enums Sequence[str]

Array of values a primitive property can be set to. See array_enum for arrays.

external_name str

External name of the user schema property.

external_namespace str

External namespace of the user schema property.

index str

Subschema unique string identifier

master str

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

max_length int

The maximum length of the user property value. Only applies to type string

min_length int

The minimum length of the user property value. Only applies to type string

one_ofs Sequence[AppUserSchemaPropertyOneOfArgs]

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions str

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required bool

Whether the subschema is required

scope str

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

title str

Subschema title (display name)

type str

The type of the schema property. It can be string, boolean, number, integer, array, or object

union bool

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique str

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

user_type str

User type ID. By default, it is default

appId String

The Application's ID the user custom schema property should be assigned to.

arrayEnums List<String>

Array of values that an array property's items can be set to.

arrayOneOfs List<Property Map>

Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'

(Required) display name for the enum value.

arrayType String

The type of the array elements if type is set to array

description String

The description of the user schema property.

enums List<String>

Array of values a primitive property can be set to. See array_enum for arrays.

externalName String

External name of the user schema property.

externalNamespace String

External namespace of the user schema property.

index String

Subschema unique string identifier

master String

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA

maxLength Number

The maximum length of the user property value. Only applies to type string

minLength Number

The minimum length of the user property value. Only applies to type string

oneOfs List<Property Map>

Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of 'enum'. - 'title' - (Required) display name for the enum value.

permissions String

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY

required Boolean

Whether the subschema is required

scope String

determines whether an app user attribute can be set at the Personal SELF or Group NONE level. Default value is NONE.

title String

Subschema title (display name)

type String

The type of the schema property. It can be string, boolean, number, integer, array, or object

union Boolean

If type is set to array, used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to SELF.

unique String

Whether the property should be unique. It can be set to UNIQUE_VALIDATED or NOT_UNIQUE.

userType String

User type ID. By default, it is default

Supporting Types

AppUserSchemaPropertyArrayOneOf
, AppUserSchemaPropertyArrayOneOfArgs

Const string: Value mapping to member of array_enum
Title string: Display name for the enum value.

Const string: Value mapping to member of array_enum
Title string: Display name for the enum value.

const_ String: Value mapping to member of array_enum
title String: Display name for the enum value.

const string: Value mapping to member of array_enum
title string: Display name for the enum value.

const str: Value mapping to member of array_enum
title str: Display name for the enum value.

const String: Value mapping to member of array_enum
title String: Display name for the enum value.

AppUserSchemaPropertyOneOf
, AppUserSchemaPropertyOneOfArgs

Const string: Enum value
Title string: Enum title

Const string: Enum value
Title string: Enum title

const_ String: Enum value
title String: Enum title

const string: Enum value
title string: Enum title

const str: Enum value
title str: Enum title

const String: Enum value
title String: Enum title

Import

$ pulumi import okta:index/appUserSchemaProperty:AppUserSchemaProperty example <app_id>/<property_name>

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 v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-okta

okta.AppUserSchemaProperty

On this page

On this page

Example Usage

Create AppUserSchemaProperty Resource

Constructor syntax

Parameters

Constructor example

AppUserSchemaProperty Resource Properties

Inputs

Outputs

Look up Existing AppUserSchemaProperty Resource

Supporting Types

AppUserSchemaPropertyArrayOneOf
, AppUserSchemaPropertyArrayOneOfArgs

AppUserSchemaPropertyOneOf
, AppUserSchemaPropertyOneOfArgs

Import

Package Details

On this page

On this page

okta.AppUserSchemaProperty

On this page

On this page

Example Usage

Create AppUserSchemaProperty Resource

Constructor syntax

Parameters

Constructor example

AppUserSchemaProperty Resource Properties

Inputs

Outputs

Look up Existing AppUserSchemaProperty Resource

Supporting Types

AppUserSchemaPropertyArrayOneOf, AppUserSchemaPropertyArrayOneOfArgs

AppUserSchemaPropertyOneOf, AppUserSchemaPropertyOneOfArgs

Import

Package Details

On this page

On this page

AppUserSchemaPropertyArrayOneOf
, AppUserSchemaPropertyArrayOneOfArgs

AppUserSchemaPropertyOneOf
, AppUserSchemaPropertyOneOfArgs