BaseSchema

Manages a User Base Schema property.

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.User.BaseSchema("example", new Okta.User.BaseSchemaArgs
        {
            Index = "customPropertyName",
            Master = "OKTA",
            Title = "customPropertyName",
            Type = "string",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.user.BaseSchema("example",
    index="customPropertyName",
    master="OKTA",
    title="customPropertyName",
    type="string")

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",
});

Create a BaseSchema Resource

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

def BaseSchema(resource_name, opts=None, index=None, master=None, permissions=None, required=None, title=None, type=None, __props__=None);

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

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

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.
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 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.

BaseSchema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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".
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.

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".
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.

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".
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.

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".
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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, index=None, master=None, permissions=None, required=None, title=None, type=None, __props__=None);

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)

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:

Index string: The property name.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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".

Index string: The property name.
Master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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".

index string: The property name.
master string: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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".

index str: The property name.
master str: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
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".

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