Okta v3.23.0, Apr 20 23

okta.AppUserSchemaProperty

Explore with Pulumi AI

Import

App user schema property can be imported via the property index and app id.

 $ pulumi import okta:index/appUserSchemaProperty:AppUserSchemaProperty example &#60;app id&#62;/&#60;property name&#62;

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.AppUserSchemaProperty("example", new()
    {
        AppId = "<app id>",
        Description = "My custom property name",
        Index = "customPropertyName",
        Master = "OKTA",
        Scope = "SELF",
        Title = "customPropertyName",
        Type = "string",
    });

});

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewAppUserSchemaProperty(ctx, "example", &okta.AppUserSchemaPropertyArgs{
			AppId:       pulumi.String("<app id>"),
			Description: pulumi.String("My custom property name"),
			Index:       pulumi.String("customPropertyName"),
			Master:      pulumi.String("OKTA"),
			Scope:       pulumi.String("SELF"),
			Title:       pulumi.String("customPropertyName"),
			Type:        pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.AppUserSchemaProperty;
import com.pulumi.okta.AppUserSchemaPropertyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AppUserSchemaProperty("example", AppUserSchemaPropertyArgs.builder()        
            .appId("<app id>")
            .description("My custom property name")
            .index("customPropertyName")
            .master("OKTA")
            .scope("SELF")
            .title("customPropertyName")
            .type("string")
            .build());

    }
}

import pulumi
import pulumi_okta as okta

example = okta.AppUserSchemaProperty("example",
    app_id="<app id>",
    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.AppUserSchemaProperty("example", {
    appId: "<app id>",
    description: "My custom property name",
    index: "customPropertyName",
    master: "OKTA",
    scope: "SELF",
    title: "customPropertyName",
    type: "string",
});

resources:
  example:
    type: okta:AppUserSchemaProperty
    properties:
      appId: <app id>
      description: My custom property name
      index: customPropertyName
      master: OKTA
      scope: SELF
      title: customPropertyName
      type: string

Create AppUserSchemaProperty Resource

new AppUserSchemaProperty(name: string, args: AppUserSchemaPropertyArgs, opts?: CustomResourceOptions);

@overload
def AppUserSchemaProperty(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          app_id: Optional[str] = None,
                          array_enums: Optional[Sequence[str]] = None,
                          array_one_ofs: Optional[Sequence[AppUserSchemaPropertyArrayOneOfArgs]] = None,
                          array_type: Optional[str] = None,
                          description: Optional[str] = None,
                          enums: Optional[Sequence[str]] = None,
                          external_name: Optional[str] = None,
                          external_namespace: Optional[str] = None,
                          index: Optional[str] = None,
                          master: Optional[str] = None,
                          max_length: Optional[int] = None,
                          min_length: Optional[int] = None,
                          one_ofs: Optional[Sequence[AppUserSchemaPropertyOneOfArgs]] = None,
                          permissions: Optional[str] = None,
                          required: Optional[bool] = None,
                          scope: Optional[str] = None,
                          title: Optional[str] = None,
                          type: Optional[str] = None,
                          union: Optional[bool] = None,
                          unique: Optional[str] = None,
                          user_type: Optional[str] = None)
@overload
def AppUserSchemaProperty(resource_name: str,
                          args: AppUserSchemaPropertyArgs,
                          opts: Optional[ResourceOptions] = None)

func NewAppUserSchemaProperty(ctx *Context, name string, args AppUserSchemaPropertyArgs, opts ...ResourceOption) (*AppUserSchemaProperty, error)

public AppUserSchemaProperty(string name, AppUserSchemaPropertyArgs args, CustomResourceOptions? opts = null)

public AppUserSchemaProperty(String name, AppUserSchemaPropertyArgs args)
public AppUserSchemaProperty(String name, AppUserSchemaPropertyArgs args, CustomResourceOptions options)

type: okta:AppUserSchemaProperty
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

resource_name str: The unique name of the resource.
args AppUserSchemaPropertyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args AppUserSchemaPropertyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AppUserSchemaProperty Resource Properties

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

Inputs

The AppUserSchemaProperty resource accepts the following input properties:

AppId string: The Application's ID the user custom schema property should be assigned to.
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<AppUserSchemaPropertyArrayOneOfArgs>: 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.
ExternalNamespace string: External namespace 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<AppUserSchemaPropertyOneOfArgs>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
Union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
Unique string: Subschema unique restriction
UserType string: Custom subschema user type

AppId string: The Application's ID the user custom schema property should be assigned to.
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 []AppUserSchemaPropertyArrayOneOfArgs: 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.
ExternalNamespace string: External namespace 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 []AppUserSchemaPropertyOneOfArgs: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
Union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
Unique string: Subschema unique restriction
UserType string: Custom subschema user type

appId String: The Application's ID the user custom schema property should be assigned to.
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<AppUserSchemaPropertyArrayOneOfArgs>: 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.
externalNamespace String: External namespace of the user schema property.
master String: Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".
maxLength Integer: The maximum length of the user property value. Only applies to type "string".
minLength Integer: The minimum length of the user property value. Only applies to type "string".
oneOfs List<AppUserSchemaPropertyOneOfArgs>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
union Boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique String: Subschema unique restriction
userType String: Custom subschema user type

appId string: The Application's ID the user custom schema property should be assigned to.
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 AppUserSchemaPropertyArrayOneOfArgs[]: 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.
externalNamespace string: External namespace 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 AppUserSchemaPropertyOneOfArgs[]: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
union boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique string: Subschema unique restriction
userType string: Custom subschema user type

app_id str: The Application's ID the user custom schema property should be assigned to.
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 Sequence[str]: Array of values that an array property's items can be set to.
array_one_ofs Sequence[AppUserSchemaPropertyArrayOneOfArgs]: 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 Sequence[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.
external_namespace str: External namespace 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 int: The maximum length of the user property value. Only applies to type "string".
min_length int: The minimum length of the user property value. Only applies to type "string".
one_ofs Sequence[AppUserSchemaPropertyOneOfArgs]: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique str: Subschema unique restriction
user_type str: Custom subschema user type

appId String: The Application's ID the user custom schema property should be assigned to.
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<Property Map>: 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.
externalNamespace String: External namespace 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 List<Property Map>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
union Boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique String: Subschema unique restriction
userType String: Custom subschema user type

Outputs

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

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AppUserSchemaProperty Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        array_enums: Optional[Sequence[str]] = None,
        array_one_ofs: Optional[Sequence[AppUserSchemaPropertyArrayOneOfArgs]] = None,
        array_type: Optional[str] = None,
        description: Optional[str] = None,
        enums: Optional[Sequence[str]] = None,
        external_name: Optional[str] = None,
        external_namespace: Optional[str] = None,
        index: Optional[str] = None,
        master: Optional[str] = None,
        max_length: Optional[int] = None,
        min_length: Optional[int] = None,
        one_ofs: Optional[Sequence[AppUserSchemaPropertyOneOfArgs]] = None,
        permissions: Optional[str] = None,
        required: Optional[bool] = None,
        scope: Optional[str] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        union: Optional[bool] = None,
        unique: Optional[str] = None,
        user_type: Optional[str] = None) -> AppUserSchemaProperty

func GetAppUserSchemaProperty(ctx *Context, name string, id IDInput, state *AppUserSchemaPropertyState, opts ...ResourceOption) (*AppUserSchemaProperty, error)

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

public static AppUserSchemaProperty get(String name, Output<String> id, AppUserSchemaPropertyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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 custom schema property should be assigned to.
ArrayEnums List<string>: Array of values that an array property's items can be set to.
ArrayOneOfs List<AppUserSchemaPropertyArrayOneOfArgs>: 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.
ExternalNamespace string: External namespace 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<AppUserSchemaPropertyOneOfArgs>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
Union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
Unique string: Subschema unique restriction
UserType string: Custom subschema user type

AppId string: The Application's ID the user custom schema property should be assigned to.
ArrayEnums []string: Array of values that an array property's items can be set to.
ArrayOneOfs []AppUserSchemaPropertyArrayOneOfArgs: 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.
ExternalNamespace string: External namespace 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 []AppUserSchemaPropertyOneOfArgs: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
Union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
Unique string: Subschema unique restriction
UserType string: Custom subschema user type

appId String: The Application's ID the user custom schema property should be assigned to.
arrayEnums List<String>: Array of values that an array property's items can be set to.
arrayOneOfs List<AppUserSchemaPropertyArrayOneOfArgs>: 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.
externalNamespace String: External namespace 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 Integer: The maximum length of the user property value. Only applies to type "string".
minLength Integer: The minimum length of the user property value. Only applies to type "string".
oneOfs List<AppUserSchemaPropertyOneOfArgs>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
union Boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique String: Subschema unique restriction
userType String: Custom subschema user type

appId string: The Application's ID the user custom schema property should be assigned to.
arrayEnums string[]: Array of values that an array property's items can be set to.
arrayOneOfs AppUserSchemaPropertyArrayOneOfArgs[]: 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.
externalNamespace string: External namespace 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 AppUserSchemaPropertyOneOfArgs[]: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
union boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique string: Subschema unique restriction
userType string: Custom subschema user type

app_id str: The Application's ID the user custom schema property should be assigned to.
array_enums Sequence[str]: Array of values that an array property's items can be set to.
array_one_ofs Sequence[AppUserSchemaPropertyArrayOneOfArgs]: 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 Sequence[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.
external_namespace str: External namespace 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 int: The maximum length of the user property value. Only applies to type "string".
min_length int: The minimum length of the user property value. Only applies to type "string".
one_ofs Sequence[AppUserSchemaPropertyOneOfArgs]: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
union bool: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique str: Subschema unique restriction
user_type str: Custom subschema user type

appId String: The Application's ID the user custom schema property should be assigned to.
arrayEnums List<String>: Array of values that an array property's items can be set to.
arrayOneOfs List<Property Map>: 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.
externalNamespace String: External namespace 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 List<Property Map>: 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 Personal "SELF" or Group "NONE" level. Default value is "NONE".
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".
union Boolean: If type is set to "array", used to set whether attribute value is determined by group priority false, or combine values across groups true. Can not be set to true if scope is set to "SELF".
unique String: Subschema unique restriction
userType String: Custom subschema user type

Supporting Types

AppUserSchemaPropertyArrayOneOf

Const string: value mapping to member of array_enum.
Title string: display name for the enum value.

Const string: value mapping to member of array_enum.
Title string: display name for the enum value.

const_ String: value mapping to member of array_enum.
title String: display name for the enum value.

const string: value mapping to member of array_enum.
title string: display name for the enum value.

const str: value mapping to member of array_enum.
title str: display name for the enum value.

const String: value mapping to member of array_enum.
title String: display name for the enum value.

AppUserSchemaPropertyOneOf

Const string: value mapping to member of array_enum.
Title string: display name for the enum value.

Const string: value mapping to member of array_enum.
Title string: display name for the enum value.

const_ String: value mapping to member of array_enum.
title String: display name for the enum value.

const string: value mapping to member of array_enum.
title string: display name for the enum value.

const str: value mapping to member of array_enum.
title str: display name for the enum value.

const String: value mapping to member of array_enum.
title String: display name for the enum value.

Package Details

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