UserBaseSchema

Manages an Application User Base Schema property.

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.App.UserBaseSchema("example", new Okta.App.UserBaseSchemaArgs
        {
            AppId = "<app id>",
            Index = "customPropertyName",
            Master = "OKTA",
            Title = "customPropertyName",
            Type = "string",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.app.UserBaseSchema("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.app.UserBaseSchema("example", {
    appId: "<app id>",
    index: "customPropertyName",
    master: "OKTA",
    title: "customPropertyName",
    type: "string",
});

Create a UserBaseSchema Resource

new UserBaseSchema(name: string, args: UserBaseSchemaArgs, opts?: CustomResourceOptions);

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

func NewUserBaseSchema(ctx *Context, name string, args UserBaseSchemaArgs, opts ...ResourceOption) (*UserBaseSchema, error)

public UserBaseSchema(string name, UserBaseSchemaArgs args, CustomResourceOptions? opts = null)

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

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

UserBaseSchema Resource Properties

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

Inputs

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

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

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

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

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

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

func GetUserBaseSchema(ctx *Context, name string, id IDInput, state *UserBaseSchemaState, opts ...ResourceOption) (*UserBaseSchema, error)

public static UserBaseSchema Get(string name, Input<string> id, UserBaseSchemaState? 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:

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

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

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

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