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

okta.UserBaseSchemaProperty

Explore with Pulumi AI

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

    Manages a User Base Schema property.

    This resource allows you to configure a base user schema property.

    IMPORTANT NOTE:

    Based on the official documentation base properties can not be modified, except to update permissions, to change the nullability of firstName and lastName (required property) or to specify a pattern for login. Currently, title and type are required, so they should be set to the current values of the base property. This will be fixed in the future releases, as this is a breaking change.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.UserBaseSchemaProperty("example", new()
        {
            Index = "firstName",
            Master = "OKTA",
            Required = true,
            Title = "First name",
            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.NewUserBaseSchemaProperty(ctx, "example", &okta.UserBaseSchemaPropertyArgs{
    			Index:    pulumi.String("firstName"),
    			Master:   pulumi.String("OKTA"),
    			Required: pulumi.Bool(true),
    			Title:    pulumi.String("First name"),
    			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.UserBaseSchemaProperty;
    import com.pulumi.okta.UserBaseSchemaPropertyArgs;
    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 UserBaseSchemaProperty("example", UserBaseSchemaPropertyArgs.builder()        
                .index("firstName")
                .master("OKTA")
                .required(true)
                .title("First name")
                .type("string")
                .userType(data.okta_user_type().example().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.UserBaseSchemaProperty("example",
        index="firstName",
        master="OKTA",
        required=True,
        title="First name",
        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.UserBaseSchemaProperty("example", {
        index: "firstName",
        master: "OKTA",
        required: true,
        title: "First name",
        type: "string",
        userType: data.okta_user_type.example.id,
    });
    
    resources:
      example:
        type: okta:UserBaseSchemaProperty
        properties:
          index: firstName
          master: OKTA
          required: true
          title: First name
          type: string
          userType: ${data.okta_user_type.example.id}
    

    Create UserBaseSchemaProperty Resource

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

    Constructor syntax

    new UserBaseSchemaProperty(name: string, args: UserBaseSchemaPropertyArgs, opts?: CustomResourceOptions);
    @overload
    def UserBaseSchemaProperty(resource_name: str,
                               args: UserBaseSchemaPropertyArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserBaseSchemaProperty(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               index: Optional[str] = None,
                               title: Optional[str] = None,
                               type: Optional[str] = None,
                               master: Optional[str] = None,
                               pattern: Optional[str] = None,
                               permissions: Optional[str] = None,
                               required: Optional[bool] = None,
                               user_type: Optional[str] = None)
    func NewUserBaseSchemaProperty(ctx *Context, name string, args UserBaseSchemaPropertyArgs, opts ...ResourceOption) (*UserBaseSchemaProperty, error)
    public UserBaseSchemaProperty(string name, UserBaseSchemaPropertyArgs args, CustomResourceOptions? opts = null)
    public UserBaseSchemaProperty(String name, UserBaseSchemaPropertyArgs args)
    public UserBaseSchemaProperty(String name, UserBaseSchemaPropertyArgs args, CustomResourceOptions options)
    
    type: okta:UserBaseSchemaProperty
    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 UserBaseSchemaPropertyArgs
    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 UserBaseSchemaPropertyArgs
    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 UserBaseSchemaPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserBaseSchemaPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserBaseSchemaPropertyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var userBaseSchemaPropertyResource = new Okta.UserBaseSchemaProperty("userBaseSchemaPropertyResource", new()
    {
        Index = "string",
        Title = "string",
        Type = "string",
        Master = "string",
        Pattern = "string",
        Permissions = "string",
        Required = false,
        UserType = "string",
    });
    
    example, err := okta.NewUserBaseSchemaProperty(ctx, "userBaseSchemaPropertyResource", &okta.UserBaseSchemaPropertyArgs{
    	Index:       pulumi.String("string"),
    	Title:       pulumi.String("string"),
    	Type:        pulumi.String("string"),
    	Master:      pulumi.String("string"),
    	Pattern:     pulumi.String("string"),
    	Permissions: pulumi.String("string"),
    	Required:    pulumi.Bool(false),
    	UserType:    pulumi.String("string"),
    })
    
    var userBaseSchemaPropertyResource = new UserBaseSchemaProperty("userBaseSchemaPropertyResource", UserBaseSchemaPropertyArgs.builder()        
        .index("string")
        .title("string")
        .type("string")
        .master("string")
        .pattern("string")
        .permissions("string")
        .required(false)
        .userType("string")
        .build());
    
    user_base_schema_property_resource = okta.UserBaseSchemaProperty("userBaseSchemaPropertyResource",
        index="string",
        title="string",
        type="string",
        master="string",
        pattern="string",
        permissions="string",
        required=False,
        user_type="string")
    
    const userBaseSchemaPropertyResource = new okta.UserBaseSchemaProperty("userBaseSchemaPropertyResource", {
        index: "string",
        title: "string",
        type: "string",
        master: "string",
        pattern: "string",
        permissions: "string",
        required: false,
        userType: "string",
    });
    
    type: okta:UserBaseSchemaProperty
    properties:
        index: string
        master: string
        pattern: string
        permissions: string
        required: false
        title: string
        type: string
        userType: string
    

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

    Index string
    The property name.
    Title string
    The property display name.
    Type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    Master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    Pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    UserType string
    User type ID.
    Index string
    The property name.
    Title string
    The property display name.
    Type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    Master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    Pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    UserType string
    User type ID.
    index String
    The property name.
    title String
    The property display name.
    type String
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    master String
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern String
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    userType String
    User type ID.
    index string
    The property name.
    title string
    The property display name.
    type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    userType string
    User type ID.
    index str
    The property name.
    title str
    The property display name.
    type str
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    master str
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern str
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    user_type str
    User type ID.
    index String
    The property name.
    title String
    The property display name.
    type String
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    master String
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern String
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    userType String
    User type ID.

    Outputs

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

    Get an existing UserBaseSchemaProperty 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?: UserBaseSchemaPropertyState, opts?: CustomResourceOptions): UserBaseSchemaProperty
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            index: Optional[str] = None,
            master: Optional[str] = None,
            pattern: Optional[str] = None,
            permissions: Optional[str] = None,
            required: Optional[bool] = None,
            title: Optional[str] = None,
            type: Optional[str] = None,
            user_type: Optional[str] = None) -> UserBaseSchemaProperty
    func GetUserBaseSchemaProperty(ctx *Context, name string, id IDInput, state *UserBaseSchemaPropertyState, opts ...ResourceOption) (*UserBaseSchemaProperty, error)
    public static UserBaseSchemaProperty Get(string name, Input<string> id, UserBaseSchemaPropertyState? state, CustomResourceOptions? opts = null)
    public static UserBaseSchemaProperty get(String name, Output<String> id, UserBaseSchemaPropertyState 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:
    Index string
    The property name.
    Master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    Pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    Title string
    The property display name.
    Type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    UserType string
    User type ID.
    Index string
    The property name.
    Master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    Pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    Title string
    The property display name.
    Type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    UserType string
    User type ID.
    index String
    The property name.
    master String
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern String
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    title String
    The property display name.
    type String
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    userType String
    User type ID.
    index string
    The property name.
    master string
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern string
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    title string
    The property display name.
    type string
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    userType string
    User type ID.
    index str
    The property name.
    master str
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern str
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    title str
    The property display name.
    type str
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    user_type str
    User type ID.
    index String
    The property name.
    master String
    Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
    pattern String
    The validation pattern to use for the subschema, only available for login property. Must be in form of .+, or [<pattern>]+.
    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 this application's users.
    title String
    The property display name.
    type String
    The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
    userType String
    User type ID.

    Import

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

    $ pulumi import okta:index/userBaseSchemaProperty:UserBaseSchemaProperty example &#60;property name&#62;
    

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

    $ pulumi import okta:index/userBaseSchemaProperty:UserBaseSchemaProperty example &#60;user type id&#62;.&#60;property name&#62;
    

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