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

}

Inheritance

System.Object

Resource

CustomResource

UserBaseSchema

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

Assembly: Pulumi.Okta.dll

Syntax

public class UserBaseSchema : CustomResource

Constructors

UserBaseSchema(String, UserBaseSchemaArgs, CustomResourceOptions)

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

Declaration

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

Parameters

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

Properties

AppId

The Application's ID the user schema property should be assigned to.

Declaration

public Output<string> AppId { 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>

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

Title

The property display name.

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>, UserBaseSchemaState, CustomResourceOptions)

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

Declaration

public static UserBaseSchema Get(string name, Input<string> id, UserBaseSchemaState 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.
UserBaseSchemaState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
UserBaseSchema