1. Packages
  2. Okta
  3. API Docs
  4. UserSchemaProperty
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.UserSchemaProperty

Explore with Pulumi AI

okta logo
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

    Import

    User schema property of default user type can be imported via the property variableName.

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

    User schema property of custom user type can be imported via user type id and property index

    $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example <user type id>.<index>
    

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.UserSchemaProperty("example", new()
        {
            Description = "My custom property name",
            Index = "customPropertyName",
            Master = "OKTA",
            Scope = "SELF",
            Title = "customPropertyName",
            Type = "string",
            UserType = data.Okta_user_type.Example.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{
    			Description: pulumi.String("My custom property name"),
    			Index:       pulumi.String("customPropertyName"),
    			Master:      pulumi.String("OKTA"),
    			Scope:       pulumi.String("SELF"),
    			Title:       pulumi.String("customPropertyName"),
    			Type:        pulumi.String("string"),
    			UserType:    pulumi.Any(data.Okta_user_type.Example.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()        
                .description("My custom property name")
                .index("customPropertyName")
                .master("OKTA")
                .scope("SELF")
                .title("customPropertyName")
                .type("string")
                .userType(data.okta_user_type().example().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.UserSchemaProperty("example",
        description="My custom property name",
        index="customPropertyName",
        master="OKTA",
        scope="SELF",
        title="customPropertyName",
        type="string",
        user_type=data["okta_user_type"]["example"]["id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.UserSchemaProperty("example", {
        description: "My custom property name",
        index: "customPropertyName",
        master: "OKTA",
        scope: "SELF",
        title: "customPropertyName",
        type: "string",
        userType: data.okta_user_type.example.id,
    });
    
    resources:
      example:
        type: okta:UserSchemaProperty
        properties:
          description: My custom property name
          index: customPropertyName
          master: OKTA
          scope: SELF
          title: customPropertyName
          type: string
          userType: ${data.okta_user_type.example.id}
    

    Create UserSchemaProperty Resource

    new UserSchemaProperty(name: string, args: UserSchemaPropertyArgs, opts?: CustomResourceOptions);
    @overload
    def UserSchemaProperty(resource_name: 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)
    @overload
    def UserSchemaProperty(resource_name: str,
                           args: UserSchemaPropertyArgs,
                           opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The UserSchemaProperty resource accepts the following input properties:

    Index string
    The property name.
    Title string
    display name for the enum value.
    Type string
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    Required bool
    Whether the property is required for these users.
    Scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    Unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    UserType string
    User type ID
    Index string
    The property name.
    Title string
    display name for the enum value.
    Type string
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    Required bool
    Whether the property is required for these users.
    Scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    Unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    UserType string
    User type ID
    index String
    The property name.
    title String
    display name for the enum value.
    type String
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    required Boolean
    Whether the property is required for these users.
    scope String
    determines whether an app user attribute can be set at the Individual or Group Level.
    unique String
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType String
    User type ID
    index string
    The property name.
    title string
    display name for the enum value.
    type string
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    required boolean
    Whether the property is required for these users.
    scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType string
    User type ID
    index str
    The property name.
    title str
    display name for the enum value.
    type str
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    required bool
    Whether the property is required for these users.
    scope str
    determines whether an app user attribute can be set at the Individual or Group Level.
    unique str
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    user_type str
    User type ID
    index String
    The property name.
    title String
    display name for the enum value.
    type String
    Type of profile source.
    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.
    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 name 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").
    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.
    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".
    required Boolean
    Whether the property is required for these users.
    scope String
    determines whether an app user attribute can be set at the Individual or Group Level.
    unique String
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType String
    User type ID

    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.
    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 name of the user schema property.
    Index string
    The property name.
    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").
    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.
    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".
    Required bool
    Whether the property is required for these users.
    Scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    Title string
    display name for the enum value.
    Type string
    Type of profile source.
    Unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    UserType string
    User type ID
    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.
    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 name of the user schema property.
    Index string
    The property name.
    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").
    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.
    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".
    Required bool
    Whether the property is required for these users.
    Scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    Title string
    display name for the enum value.
    Type string
    Type of profile source.
    Unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    UserType string
    User type ID
    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.
    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 name of the user schema property.
    index String
    The property name.
    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").
    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.
    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".
    required Boolean
    Whether the property is required for these users.
    scope String
    determines whether an app user attribute can be set at the Individual or Group Level.
    title String
    display name for the enum value.
    type String
    Type of profile source.
    unique String
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType String
    User type ID
    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.
    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 name of the user schema property.
    index string
    The property name.
    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").
    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.
    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".
    required boolean
    Whether the property is required for these users.
    scope string
    determines whether an app user attribute can be set at the Individual or Group Level.
    title string
    display name for the enum value.
    type string
    Type of profile source.
    unique string
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType string
    User type ID
    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.
    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 name of the user schema property.
    index str
    The property name.
    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").
    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.
    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".
    required bool
    Whether the property is required for these users.
    scope str
    determines whether an app user attribute can be set at the Individual or Group Level.
    title str
    display name for the enum value.
    type str
    Type of profile source.
    unique str
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    user_type str
    User type ID
    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.
    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 name of the user schema property.
    index String
    The property name.
    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").
    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.
    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".
    required Boolean
    Whether the property is required for these users.
    scope String
    determines whether an app user attribute can be set at the Individual or Group Level.
    title String
    display name for the enum value.
    type String
    Type of profile source.
    unique String
    Whether the property should be unique. It can be set to "UNIQUE_VALIDATED" or "NOT_UNIQUE".
    userType String
    User type ID

    Supporting Types

    UserSchemaPropertyArrayOneOf, UserSchemaPropertyArrayOneOfArgs

    Const string
    value mapping to member of enum.
    Title string
    display name for the enum value.
    Const string
    value mapping to member of enum.
    Title string
    display name for the enum value.
    const_ String
    value mapping to member of enum.
    title String
    display name for the enum value.
    const string
    value mapping to member of enum.
    title string
    display name for the enum value.
    const str
    value mapping to member of enum.
    title str
    display name for the enum value.
    const String
    value mapping to member of enum.
    title String
    display name for the enum value.

    UserSchemaPropertyMasterOverridePriority, UserSchemaPropertyMasterOverridePriorityArgs

    Value string
    ID of profile source.
    Type string
    Type of profile source.
    Value string
    ID of profile source.
    Type string
    Type of profile source.
    value String
    ID of profile source.
    type String
    Type of profile source.
    value string
    ID of profile source.
    type string
    Type of profile source.
    value str
    ID of profile source.
    type str
    Type of profile source.
    value String
    ID of profile source.
    type String
    Type of profile source.

    UserSchemaPropertyOneOf, UserSchemaPropertyOneOfArgs

    Const string
    value mapping to member of enum.
    Title string
    display name for the enum value.
    Const string
    value mapping to member of enum.
    Title string
    display name for the enum value.
    const_ String
    value mapping to member of enum.
    title String
    display name for the enum value.
    const string
    value mapping to member of enum.
    title string
    display name for the enum value.
    const str
    value mapping to member of enum.
    title str
    display name for the enum value.
    const String
    value mapping to member of enum.
    title String
    display name for the enum value.

    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.8.0 published on Saturday, Mar 2, 2024 by Pulumi