Okta v3.21.0, Mar 15 23

okta.user.BaseSchema

DEPRECATED use okta.UserBaseSchemaProperty instead.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.User.BaseSchema("example", new()
    {
        Index = "customPropertyName",
        Master = "OKTA",
        Title = "customPropertyName",
        Type = "string",
        UserType = data.Okta_user_type.Example.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewBaseSchema(ctx, "example", &user.BaseSchemaArgs{
			Index:    pulumi.String("customPropertyName"),
			Master:   pulumi.String("OKTA"),
			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.user.BaseSchema;
import com.pulumi.okta.user.BaseSchemaArgs;
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 BaseSchema("example", BaseSchemaArgs.builder()        
            .index("customPropertyName")
            .master("OKTA")
            .title("customPropertyName")
            .type("string")
            .userType(data.okta_user_type().example().id())
            .build());

    }
}

import pulumi
import pulumi_okta as okta

example = okta.user.BaseSchema("example",
    index="customPropertyName",
    master="OKTA",
    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.user.BaseSchema("example", {
    index: "customPropertyName",
    master: "OKTA",
    title: "customPropertyName",
    type: "string",
    userType: data.okta_user_type.example.id,
});

resources:
  example:
    type: okta:user:BaseSchema
    properties:
      index: customPropertyName
      master: OKTA
      title: customPropertyName
      type: string
      userType: ${data.okta_user_type.example.id}

Create BaseSchema Resource

new BaseSchema(name: string, args: BaseSchemaArgs, opts?: CustomResourceOptions);

@overload
def BaseSchema(resource_name: 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)
@overload
def BaseSchema(resource_name: str,
               args: BaseSchemaArgs,
               opts: Optional[ResourceOptions] = None)

func NewBaseSchema(ctx *Context, name string, args BaseSchemaArgs, opts ...ResourceOption) (*BaseSchema, error)

public BaseSchema(string name, BaseSchemaArgs args, CustomResourceOptions? opts = null)

public BaseSchema(String name, BaseSchemaArgs args)
public BaseSchema(String name, BaseSchemaArgs args, CustomResourceOptions options)

type: okta:user:BaseSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BaseSchemaArgs: 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 BaseSchemaArgs: 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 BaseSchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args BaseSchemaArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

BaseSchema 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 BaseSchema 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 BaseSchema 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 BaseSchema Resource

Get an existing BaseSchema 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?: BaseSchemaState, opts?: CustomResourceOptions): BaseSchema

@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) -> BaseSchema

func GetBaseSchema(ctx *Context, name string, id IDInput, state *BaseSchemaState, opts ...ResourceOption) (*BaseSchema, error)

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

public static BaseSchema get(String name, Output<String> id, BaseSchemaState 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:user/baseSchema:BaseSchema 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:user/baseSchema:BaseSchema example &#60;user type 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.