Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. UserSchemaProperty
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.UserSchemaProperty

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    Example Usage

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

const example = new okta.UserSchemaProperty("example", {
    index: "customPropertyName",
    title: "customPropertyName",
    type: "string",
    description: "My custom property name",
    master: "OKTA",
    scope: "SELF",
    userType: exampleOktaUserType.id,
});

    import pulumi
import pulumi_okta as okta

example = okta.UserSchemaProperty("example",
    index="customPropertyName",
    title="customPropertyName",
    type="string",
    description="My custom property name",
    master="OKTA",
    scope="SELF",
    user_type=example_okta_user_type["id"])

    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.NewUserSchemaProperty(ctx, "example", &okta.UserSchemaPropertyArgs{
			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"),
			UserType:    pulumi.Any(exampleOktaUserType.Id),
		})
		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.UserSchemaProperty("example", new()
    {
        Index = "customPropertyName",
        Title = "customPropertyName",
        Type = "string",
        Description = "My custom property name",
        Master = "OKTA",
        Scope = "SELF",
        UserType = exampleOktaUserType.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.UserSchemaProperty;
import com.pulumi.okta.UserSchemaPropertyArgs;
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 UserSchemaProperty("example", UserSchemaPropertyArgs.builder()
            .index("customPropertyName")
            .title("customPropertyName")
            .type("string")
            .description("My custom property name")
            .master("OKTA")
            .scope("SELF")
            .userType(exampleOktaUserType.id())
            .build());

    }
}

    resources:
  example:
    type: okta:UserSchemaProperty
    properties:
      index: customPropertyName
      title: customPropertyName
      type: string
      description: My custom property name
      master: OKTA
      scope: SELF
      userType: ${exampleOktaUserType.id}

    Create UserSchemaProperty Resource

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

    Constructor syntax

    new UserSchemaProperty(name: string, args: UserSchemaPropertyArgs, opts?: CustomResourceOptions);
    @overload
def UserSchemaProperty(resource_name: str,
                       args: UserSchemaPropertyArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def UserSchemaProperty(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       index: Optional[str] = None,
                       type: Optional[str] = None,
                       title: Optional[str] = None,
                       max_length: Optional[int] = None,
                       one_ofs: Optional[Sequence[UserSchemaPropertyOneOfArgs]] = None,
                       external_name: Optional[str] = None,
                       external_namespace: Optional[str] = None,
                       description: Optional[str] = None,
                       master: Optional[str] = None,
                       master_override_priorities: Optional[Sequence[UserSchemaPropertyMasterOverridePriorityArgs]] = None,
                       array_enums: Optional[Sequence[str]] = None,
                       min_length: Optional[int] = None,
                       enums: Optional[Sequence[str]] = None,
                       pattern: Optional[str] = None,
                       permissions: Optional[str] = None,
                       required: Optional[bool] = None,
                       scope: Optional[str] = None,
                       array_type: Optional[str] = None,
                       array_one_ofs: Optional[Sequence[UserSchemaPropertyArrayOneOfArgs]] = None,
                       unique: Optional[str] = None,
                       user_type: Optional[str] = None)
    func NewUserSchemaProperty(ctx *Context, name string, args UserSchemaPropertyArgs, opts ...ResourceOption) (*UserSchemaProperty, error)
    public UserSchemaProperty(string name, UserSchemaPropertyArgs args, CustomResourceOptions? opts = null)
    public UserSchemaProperty(String name, UserSchemaPropertyArgs args)
public UserSchemaProperty(String name, UserSchemaPropertyArgs args, CustomResourceOptions options)

    type: okta:UserSchemaProperty
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 UserSchemaPropertyArgs
    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 UserSchemaPropertyArgs
    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 UserSchemaPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserSchemaPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserSchemaPropertyArgs
    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 userSchemaPropertyResource = new Okta.UserSchemaProperty("userSchemaPropertyResource", new()
{
    Index = "string",
    Type = "string",
    Title = "string",
    MaxLength = 0,
    OneOfs = new[]
    {
        new Okta.Inputs.UserSchemaPropertyOneOfArgs
        {
            Const = "string",
            Title = "string",
        },
    },
    ExternalName = "string",
    ExternalNamespace = "string",
    Description = "string",
    Master = "string",
    MasterOverridePriorities = new[]
    {
        new Okta.Inputs.UserSchemaPropertyMasterOverridePriorityArgs
        {
            Value = "string",
            Type = "string",
        },
    },
    ArrayEnums = new[]
    {
        "string",
    },
    MinLength = 0,
    Enums = new[]
    {
        "string",
    },
    Pattern = "string",
    Permissions = "string",
    Required = false,
    Scope = "string",
    ArrayType = "string",
    ArrayOneOfs = new[]
    {
        new Okta.Inputs.UserSchemaPropertyArrayOneOfArgs
        {
            Const = "string",
            Title = "string",
        },
    },
    Unique = "string",
    UserType = "string",
});

    example, err := okta.NewUserSchemaProperty(ctx, "userSchemaPropertyResource", &okta.UserSchemaPropertyArgs{
	Index:     pulumi.String("string"),
	Type:      pulumi.String("string"),
	Title:     pulumi.String("string"),
	MaxLength: pulumi.Int(0),
	OneOfs: okta.UserSchemaPropertyOneOfArray{
		&okta.UserSchemaPropertyOneOfArgs{
			Const: pulumi.String("string"),
			Title: pulumi.String("string"),
		},
	},
	ExternalName:      pulumi.String("string"),
	ExternalNamespace: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Master:            pulumi.String("string"),
	MasterOverridePriorities: okta.UserSchemaPropertyMasterOverridePriorityArray{
		&okta.UserSchemaPropertyMasterOverridePriorityArgs{
			Value: pulumi.String("string"),
			Type:  pulumi.String("string"),
		},
	},
	ArrayEnums: pulumi.StringArray{
		pulumi.String("string"),
	},
	MinLength: pulumi.Int(0),
	Enums: pulumi.StringArray{
		pulumi.String("string"),
	},
	Pattern:     pulumi.String("string"),
	Permissions: pulumi.String("string"),
	Required:    pulumi.Bool(false),
	Scope:       pulumi.String("string"),
	ArrayType:   pulumi.String("string"),
	ArrayOneOfs: okta.UserSchemaPropertyArrayOneOfArray{
		&okta.UserSchemaPropertyArrayOneOfArgs{
			Const: pulumi.String("string"),
			Title: pulumi.String("string"),
		},
	},
	Unique:   pulumi.String("string"),
	UserType: pulumi.String("string"),
})

    var userSchemaPropertyResource = new UserSchemaProperty("userSchemaPropertyResource", UserSchemaPropertyArgs.builder()
    .index("string")
    .type("string")
    .title("string")
    .maxLength(0)
    .oneOfs(UserSchemaPropertyOneOfArgs.builder()
        .const_("string")
        .title("string")
        .build())
    .externalName("string")
    .externalNamespace("string")
    .description("string")
    .master("string")
    .masterOverridePriorities(UserSchemaPropertyMasterOverridePriorityArgs.builder()
        .value("string")
        .type("string")
        .build())
    .arrayEnums("string")
    .minLength(0)
    .enums("string")
    .pattern("string")
    .permissions("string")
    .required(false)
    .scope("string")
    .arrayType("string")
    .arrayOneOfs(UserSchemaPropertyArrayOneOfArgs.builder()
        .const_("string")
        .title("string")
        .build())
    .unique("string")
    .userType("string")
    .build());

    user_schema_property_resource = okta.UserSchemaProperty("userSchemaPropertyResource",
    index="string",
    type="string",
    title="string",
    max_length=0,
    one_ofs=[{
        "const": "string",
        "title": "string",
    }],
    external_name="string",
    external_namespace="string",
    description="string",
    master="string",
    master_override_priorities=[{
        "value": "string",
        "type": "string",
    }],
    array_enums=["string"],
    min_length=0,
    enums=["string"],
    pattern="string",
    permissions="string",
    required=False,
    scope="string",
    array_type="string",
    array_one_ofs=[{
        "const": "string",
        "title": "string",
    }],
    unique="string",
    user_type="string")

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

    type: okta:UserSchemaProperty
properties:
    arrayEnums:
        - string
    arrayOneOfs:
        - const: string
          title: string
    arrayType: string
    description: string
    enums:
        - string
    externalName: string
    externalNamespace: string
    index: string
    master: string
    masterOverridePriorities:
        - type: string
          value: string
    maxLength: 0
    minLength: 0
    oneOfs:
        - const: string
          title: string
    pattern: string
    permissions: string
    required: false
    scope: string
    title: string
    type: string
    unique: string
    userType: string

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

    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<UserSchemaPropertyArrayOneOf>
    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, OVERRIDE or OKTA.
    MasterOverridePriorities List<UserSchemaPropertyMasterOverridePriority>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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<UserSchemaPropertyOneOf>
    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.
    Pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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
    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 []UserSchemaPropertyArrayOneOfArgs
    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, OVERRIDE or OKTA.
    MasterOverridePriorities []UserSchemaPropertyMasterOverridePriorityArgs
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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 []UserSchemaPropertyOneOfArgs
    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.
    Pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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
    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<UserSchemaPropertyArrayOneOf>
    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, OVERRIDE or OKTA.
    masterOverridePriorities List<UserSchemaPropertyMasterOverridePriority>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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<UserSchemaPropertyOneOf>
    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.
    pattern String
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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
    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 UserSchemaPropertyArrayOneOf[]
    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, OVERRIDE or OKTA.
    masterOverridePriorities UserSchemaPropertyMasterOverridePriority[]
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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 UserSchemaPropertyOneOf[]
    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.
    pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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
    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[UserSchemaPropertyArrayOneOfArgs]
    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, OVERRIDE or OKTA.
    master_override_priorities Sequence[UserSchemaPropertyMasterOverridePriorityArgs]
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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[UserSchemaPropertyOneOfArgs]
    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.
    pattern str
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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
    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, OVERRIDE or OKTA.
    masterOverridePriorities List<Property Map>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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.
    pattern String
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: NONE
    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 UserSchemaProperty 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 UserSchemaProperty Resource

    Get an existing UserSchemaProperty 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?: UserSchemaPropertyState, opts?: CustomResourceOptions): UserSchemaProperty
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        array_enums: Optional[Sequence[str]] = None,
        array_one_ofs: Optional[Sequence[UserSchemaPropertyArrayOneOfArgs]] = 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,
        master_override_priorities: Optional[Sequence[UserSchemaPropertyMasterOverridePriorityArgs]] = None,
        max_length: Optional[int] = None,
        min_length: Optional[int] = None,
        one_ofs: Optional[Sequence[UserSchemaPropertyOneOfArgs]] = None,
        pattern: Optional[str] = None,
        permissions: Optional[str] = None,
        required: Optional[bool] = None,
        scope: Optional[str] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        unique: Optional[str] = None,
        user_type: Optional[str] = None) -> UserSchemaProperty
    func GetUserSchemaProperty(ctx *Context, name string, id IDInput, state *UserSchemaPropertyState, opts ...ResourceOption) (*UserSchemaProperty, error)
    public static UserSchemaProperty Get(string name, Input<string> id, UserSchemaPropertyState? state, CustomResourceOptions? opts = null)
    public static UserSchemaProperty get(String name, Output<String> id, UserSchemaPropertyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ArrayEnums List<string>
    Array of values that an array property's items can be set to.
    ArrayOneOfs List<UserSchemaPropertyArrayOneOf>
    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, OVERRIDE or OKTA.
    MasterOverridePriorities List<UserSchemaPropertyMasterOverridePriority>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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<UserSchemaPropertyOneOf>
    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.
    Pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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
    ArrayEnums []string
    Array of values that an array property's items can be set to.
    ArrayOneOfs []UserSchemaPropertyArrayOneOfArgs
    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, OVERRIDE or OKTA.
    MasterOverridePriorities []UserSchemaPropertyMasterOverridePriorityArgs
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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 []UserSchemaPropertyOneOfArgs
    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.
    Pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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
    arrayEnums List<String>
    Array of values that an array property's items can be set to.
    arrayOneOfs List<UserSchemaPropertyArrayOneOf>
    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, OVERRIDE or OKTA.
    masterOverridePriorities List<UserSchemaPropertyMasterOverridePriority>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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<UserSchemaPropertyOneOf>
    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.
    pattern String
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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
    arrayEnums string[]
    Array of values that an array property's items can be set to.
    arrayOneOfs UserSchemaPropertyArrayOneOf[]
    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, OVERRIDE or OKTA.
    masterOverridePriorities UserSchemaPropertyMasterOverridePriority[]
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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 UserSchemaPropertyOneOf[]
    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.
    pattern string
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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
    array_enums Sequence[str]
    Array of values that an array property's items can be set to.
    array_one_ofs Sequence[UserSchemaPropertyArrayOneOfArgs]
    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, OVERRIDE or OKTA.
    master_override_priorities Sequence[UserSchemaPropertyMasterOverridePriorityArgs]
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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[UserSchemaPropertyOneOfArgs]
    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.
    pattern str
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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
    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, OVERRIDE or OKTA.
    masterOverridePriorities List<Property Map>
    Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile source. - 'value' - (Required) - ID of profile source.
    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.
    pattern String
    The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'
    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 Individual or Group Level. Default: 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
    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

    UserSchemaPropertyArrayOneOf, UserSchemaPropertyArrayOneOfArgs

    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.

    UserSchemaPropertyMasterOverridePriority, UserSchemaPropertyMasterOverridePriorityArgs

    Value string
    Type string
    Value string
    Type string
    value String
    type String
    value string
    type string
    value str
    type str
    value String
    type String

    UserSchemaPropertyOneOf, UserSchemaPropertyOneOfArgs

    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/userSchemaProperty:UserSchemaProperty example <variableName>

    $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example <user_type_id>.<index>

    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 logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta