Schema

Creates a User Schema property.

This resource allows you to create and configure a custom user schema property.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.User.Schema("example", new Okta.User.SchemaArgs
        {
            Description = "My custom property name",
            Index = "customPropertyName",
            Master = "OKTA",
            Scope = "SELF",
            Title = "customPropertyName",
            Type = "string",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.user.Schema("example",
    description="My custom property name",
    index="customPropertyName",
    master="OKTA",
    scope="SELF",
    title="customPropertyName",
    type="string")

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

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

Create a Schema Resource

new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);

def Schema(resource_name, opts=None, array_enums=None, array_one_ofs=None, array_type=None, description=None, enums=None, external_name=None, index=None, master=None, max_length=None, min_length=None, one_ofs=None, permissions=None, required=None, scope=None, title=None, type=None, __props__=None);

func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)

public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Schema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Schema resource accepts the following input properties:

Index string: The property name.
Title string: display name for the enum value.
Type string: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
ArrayEnums List<string>: Array of values that an array property’s items can be set to.
ArrayOneOfs List<SchemaArrayOneOfArgs>: 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.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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<SchemaOneOfArgs>: Array of maps containing a mapping for display name to enum value.
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.
Scope string: determines whether an app user attribute can be set at the Individual or Group Level.

Index string: The property name.
Title string: display name for the enum value.
Type string: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
ArrayEnums []string: Array of values that an array property’s items can be set to.
ArrayOneOfs []SchemaArrayOneOf: 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.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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 []SchemaOneOf: Array of maps containing a mapping for display name to enum value.
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.
Scope string: determines whether an app user attribute can be set at the Individual or Group Level.

index string: The property name.
title string: display name for the enum value.
type string: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
arrayEnums string[]: Array of values that an array property’s items can be set to.
arrayOneOfs SchemaArrayOneOf[]: 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.
master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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 SchemaOneOf[]: Array of maps containing a mapping for display name to enum value.
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.
scope string: determines whether an app user attribute can be set at the Individual or Group Level.

index str: The property name.
title str: display name for the enum value.
type str: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".
array_enums List[str]: Array of values that an array property’s items can be set to.
array_one_ofs List[SchemaArrayOneOf]: 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 List[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.
master str: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
max_length float: The maximum length of the user property value. Only applies to type "string".
min_length float: The minimum length of the user property value. Only applies to type "string".
one_ofs List[SchemaOneOf]: Array of maps containing a mapping for display name to enum value.
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.
scope str: determines whether an app user attribute can be set at the Individual or Group Level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Schema 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Schema Resource

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

static get(resource_name, id, opts=None, array_enums=None, array_one_ofs=None, array_type=None, description=None, enums=None, external_name=None, index=None, master=None, max_length=None, min_length=None, one_ofs=None, permissions=None, required=None, scope=None, title=None, type=None, __props__=None);

func GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)

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

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.

The following state arguments are supported:

ArrayEnums List<string>: Array of values that an array property’s items can be set to.
ArrayOneOfs List<SchemaArrayOneOfArgs>: 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.
Index string: The property name.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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<SchemaOneOfArgs>: Array of maps containing a mapping for display name to enum value.
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.
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: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

ArrayEnums []string: Array of values that an array property’s items can be set to.
ArrayOneOfs []SchemaArrayOneOf: 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.
Index string: The property name.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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 []SchemaOneOf: Array of maps containing a mapping for display name to enum value.
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.
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: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

arrayEnums string[]: Array of values that an array property’s items can be set to.
arrayOneOfs SchemaArrayOneOf[]: 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.
index string: The property name.
master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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 SchemaOneOf[]: Array of maps containing a mapping for display name to enum value.
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.
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: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

array_enums List[str]: Array of values that an array property’s items can be set to.
array_one_ofs List[SchemaArrayOneOf]: 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 List[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.
index str: The property name.
master str: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
max_length float: The maximum length of the user property value. Only applies to type "string".
min_length float: The minimum length of the user property value. Only applies to type "string".
one_ofs List[SchemaOneOf]: Array of maps containing a mapping for display name to enum value.
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.
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: The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

Supporting Types

SchemaArrayOneOf

See the input and output API doc for this type.

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.

SchemaOneOf

See the input and output API doc for this type.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud