1. Packages
  2. Okta
  3. API Docs
  4. AppUserBaseSchemaProperty
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

okta.AppUserBaseSchemaProperty

Explore with Pulumi AI

okta logo
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

    Manages an Application User Base Schema property.

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.AppUserBaseSchemaProperty("example", new()
        {
            AppId = "<app id>",
            Index = "customPropertyName",
            Master = "OKTA",
            Title = "customPropertyName",
            Type = "string",
        });
    
    });
    
    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.NewAppUserBaseSchemaProperty(ctx, "example", &okta.AppUserBaseSchemaPropertyArgs{
    			AppId:  pulumi.String("<app id>"),
    			Index:  pulumi.String("customPropertyName"),
    			Master: pulumi.String("OKTA"),
    			Title:  pulumi.String("customPropertyName"),
    			Type:   pulumi.String("string"),
    		})
    		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.AppUserBaseSchemaProperty;
    import com.pulumi.okta.AppUserBaseSchemaPropertyArgs;
    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 AppUserBaseSchemaProperty("example", AppUserBaseSchemaPropertyArgs.builder()        
                .appId("<app id>")
                .index("customPropertyName")
                .master("OKTA")
                .title("customPropertyName")
                .type("string")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.AppUserBaseSchemaProperty("example",
        app_id="<app id>",
        index="customPropertyName",
        master="OKTA",
        title="customPropertyName",
        type="string")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.AppUserBaseSchemaProperty("example", {
        appId: "<app id>",
        index: "customPropertyName",
        master: "OKTA",
        title: "customPropertyName",
        type: "string",
    });
    
    resources:
      example:
        type: okta:AppUserBaseSchemaProperty
        properties:
          appId: <app id>
          index: customPropertyName
          master: OKTA
          title: customPropertyName
          type: string
    

    Create AppUserBaseSchemaProperty Resource

    new AppUserBaseSchemaProperty(name: string, args: AppUserBaseSchemaPropertyArgs, opts?: CustomResourceOptions);
    @overload
    def AppUserBaseSchemaProperty(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  app_id: Optional[str] = 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)
    @overload
    def AppUserBaseSchemaProperty(resource_name: str,
                                  args: AppUserBaseSchemaPropertyArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewAppUserBaseSchemaProperty(ctx *Context, name string, args AppUserBaseSchemaPropertyArgs, opts ...ResourceOption) (*AppUserBaseSchemaProperty, error)
    public AppUserBaseSchemaProperty(string name, AppUserBaseSchemaPropertyArgs args, CustomResourceOptions? opts = null)
    public AppUserBaseSchemaProperty(String name, AppUserBaseSchemaPropertyArgs args)
    public AppUserBaseSchemaProperty(String name, AppUserBaseSchemaPropertyArgs args, CustomResourceOptions options)
    
    type: okta:AppUserBaseSchemaProperty
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AppUserBaseSchemaPropertyArgs
    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 AppUserBaseSchemaPropertyArgs
    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 AppUserBaseSchemaPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppUserBaseSchemaPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppUserBaseSchemaPropertyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AppId string

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

    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. By default, it is "default".

    AppId string

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

    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. By default, it is "default".

    appId String

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

    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. By default, it is "default".

    appId string

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

    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. By default, it is "default".

    app_id str

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

    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. By default, it is "default".

    appId String

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

    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. By default, it is "default".

    Outputs

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

    Get an existing AppUserBaseSchemaProperty 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?: AppUserBaseSchemaPropertyState, opts?: CustomResourceOptions): AppUserBaseSchemaProperty
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_id: Optional[str] = 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) -> AppUserBaseSchemaProperty
    func GetAppUserBaseSchemaProperty(ctx *Context, name string, id IDInput, state *AppUserBaseSchemaPropertyState, opts ...ResourceOption) (*AppUserBaseSchemaProperty, error)
    public static AppUserBaseSchemaProperty Get(string name, Input<string> id, AppUserBaseSchemaPropertyState? state, CustomResourceOptions? opts = null)
    public static AppUserBaseSchemaProperty get(String name, Output<String> id, AppUserBaseSchemaPropertyState 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:
    AppId string

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

    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. By default, it is "default".

    AppId string

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

    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. By default, it is "default".

    appId String

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

    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. By default, it is "default".

    appId string

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

    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. By default, it is "default".

    app_id str

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

    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. By default, it is "default".

    appId String

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

    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. By default, it is "default".

    Import

    App user base schema property can be imported via the property index and app id.

     $ pulumi import okta:index/appUserBaseSchemaProperty:AppUserBaseSchemaProperty example &#60;app id&#62;/&#60;property name&#62;
    

    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.4.0 published on Monday, Sep 18, 2023 by Pulumi