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

}

Inheritance

System.Object

Resource

CustomResource

Schema

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Okta.User

Assembly: Pulumi.Okta.dll

Syntax

public class Schema : CustomResource

Constructors

Schema(String, SchemaArgs, CustomResourceOptions)

Create a Schema resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SchemaArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ArrayEnums

Array of values that an array property's items can be set to.

Declaration

public Output<ImmutableArray<string>> ArrayEnums { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ArrayOneOfs

Display name and value an enum array can be set to.

Declaration

public Output<ImmutableArray<SchemaArrayOneOf>> ArrayOneOfs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<SchemaArrayOneOf>>

ArrayType

The type of the array elements if type is set to "array".

Declaration

public Output<string> ArrayType { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the user schema property.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Enums

Array of values a primitive property can be set to. See array_enum for arrays.

Declaration

public Output<ImmutableArray<string>> Enums { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ExternalName

External name of the user schema property.

Declaration

public Output<string> ExternalName { get; }

Property Value

Type	Description
Output<System.String>

Index

The property name.

Declaration

public Output<string> Index { get; }

Property Value

Type	Description
Output<System.String>

Master

Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

Declaration

public Output<string> Master { get; }

Property Value

Type	Description
Output<System.String>

MaxLength

The maximum length of the user property value. Only applies to type "string".

Declaration

public Output<int?> MaxLength { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MinLength

The minimum length of the user property value. Only applies to type "string".

Declaration

public Output<int?> MinLength { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

OneOfs

Array of maps containing a mapping for display name to enum value.

Declaration

public Output<ImmutableArray<SchemaOneOf>> OneOfs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<SchemaOneOf>>

Permissions

Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

Declaration

public Output<string> Permissions { get; }

Property Value

Type	Description
Output<System.String>

Required

Whether the property is required for this application's users.

Declaration

public Output<bool?> Required { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Scope

determines whether an app user attribute can be set at the Individual or Group Level.

Declaration

public Output<string> Scope { get; }

Property Value

Type	Description
Output<System.String>

Title

display name for the enum value.

Declaration

public Output<string> Title { get; }

Property Value

Type	Description
Output<System.String>

Type

The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, SchemaState, CustomResourceOptions)

Get an existing Schema resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SchemaState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Schema