okta.AppUserSchemaProperty
Explore with Pulumi AI
Example Usage
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",
});
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")
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/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
})
}
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 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());
}
}
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppUserSchemaProperty(name: string, args: AppUserSchemaPropertyArgs, opts?: CustomResourceOptions);
@overload
def AppUserSchemaProperty(resource_name: str,
args: AppUserSchemaPropertyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppUserSchemaProperty(resource_name: str,
opts: Optional[ResourceOptions] = None,
index: Optional[str] = None,
type: Optional[str] = None,
title: Optional[str] = None,
app_id: Optional[str] = None,
max_length: Optional[int] = None,
permissions: Optional[str] = None,
external_name: Optional[str] = None,
external_namespace: Optional[str] = None,
description: Optional[str] = None,
master: Optional[str] = None,
array_type: Optional[str] = None,
min_length: Optional[int] = None,
one_ofs: Optional[Sequence[AppUserSchemaPropertyOneOfArgs]] = None,
enums: Optional[Sequence[str]] = None,
required: Optional[bool] = None,
scope: Optional[str] = None,
array_one_ofs: Optional[Sequence[AppUserSchemaPropertyArrayOneOfArgs]] = None,
array_enums: Optional[Sequence[str]] = None,
union: Optional[bool] = None,
unique: Optional[str] = None,
user_type: Optional[str] = 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.
Parameters
- 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.
Example
The following reference example uses placeholder values for all input properties.
var appUserSchemaPropertyResource = new Okta.AppUserSchemaProperty("appUserSchemaPropertyResource", new()
{
Index = "string",
Type = "string",
Title = "string",
AppId = "string",
MaxLength = 0,
Permissions = "string",
ExternalName = "string",
ExternalNamespace = "string",
Description = "string",
Master = "string",
ArrayType = "string",
MinLength = 0,
OneOfs = new[]
{
new Okta.Inputs.AppUserSchemaPropertyOneOfArgs
{
Const = "string",
Title = "string",
},
},
Enums = new[]
{
"string",
},
Required = false,
Scope = "string",
ArrayOneOfs = new[]
{
new Okta.Inputs.AppUserSchemaPropertyArrayOneOfArgs
{
Const = "string",
Title = "string",
},
},
ArrayEnums = new[]
{
"string",
},
Union = false,
Unique = "string",
UserType = "string",
});
example, err := okta.NewAppUserSchemaProperty(ctx, "appUserSchemaPropertyResource", &okta.AppUserSchemaPropertyArgs{
Index: pulumi.String("string"),
Type: pulumi.String("string"),
Title: pulumi.String("string"),
AppId: pulumi.String("string"),
MaxLength: pulumi.Int(0),
Permissions: pulumi.String("string"),
ExternalName: pulumi.String("string"),
ExternalNamespace: pulumi.String("string"),
Description: pulumi.String("string"),
Master: pulumi.String("string"),
ArrayType: pulumi.String("string"),
MinLength: pulumi.Int(0),
OneOfs: okta.AppUserSchemaPropertyOneOfArray{
&okta.AppUserSchemaPropertyOneOfArgs{
Const: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
Enums: pulumi.StringArray{
pulumi.String("string"),
},
Required: pulumi.Bool(false),
Scope: pulumi.String("string"),
ArrayOneOfs: okta.AppUserSchemaPropertyArrayOneOfArray{
&okta.AppUserSchemaPropertyArrayOneOfArgs{
Const: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
ArrayEnums: pulumi.StringArray{
pulumi.String("string"),
},
Union: pulumi.Bool(false),
Unique: pulumi.String("string"),
UserType: pulumi.String("string"),
})
var appUserSchemaPropertyResource = new AppUserSchemaProperty("appUserSchemaPropertyResource", AppUserSchemaPropertyArgs.builder()
.index("string")
.type("string")
.title("string")
.appId("string")
.maxLength(0)
.permissions("string")
.externalName("string")
.externalNamespace("string")
.description("string")
.master("string")
.arrayType("string")
.minLength(0)
.oneOfs(AppUserSchemaPropertyOneOfArgs.builder()
.const_("string")
.title("string")
.build())
.enums("string")
.required(false)
.scope("string")
.arrayOneOfs(AppUserSchemaPropertyArrayOneOfArgs.builder()
.const_("string")
.title("string")
.build())
.arrayEnums("string")
.union(false)
.unique("string")
.userType("string")
.build());
app_user_schema_property_resource = okta.AppUserSchemaProperty("appUserSchemaPropertyResource",
index="string",
type="string",
title="string",
app_id="string",
max_length=0,
permissions="string",
external_name="string",
external_namespace="string",
description="string",
master="string",
array_type="string",
min_length=0,
one_ofs=[okta.AppUserSchemaPropertyOneOfArgs(
const="string",
title="string",
)],
enums=["string"],
required=False,
scope="string",
array_one_ofs=[okta.AppUserSchemaPropertyArrayOneOfArgs(
const="string",
title="string",
)],
array_enums=["string"],
union=False,
unique="string",
user_type="string")
const appUserSchemaPropertyResource = new okta.AppUserSchemaProperty("appUserSchemaPropertyResource", {
index: "string",
type: "string",
title: "string",
appId: "string",
maxLength: 0,
permissions: "string",
externalName: "string",
externalNamespace: "string",
description: "string",
master: "string",
arrayType: "string",
minLength: 0,
oneOfs: [{
"const": "string",
title: "string",
}],
enums: ["string"],
required: false,
scope: "string",
arrayOneOfs: [{
"const": "string",
title: "string",
}],
arrayEnums: ["string"],
union: false,
unique: "string",
userType: "string",
});
type: okta:AppUserSchemaProperty
properties:
appId: string
arrayEnums:
- string
arrayOneOfs:
- const: string
title: string
arrayType: string
description: string
enums:
- string
externalName: string
externalNamespace: string
index: string
master: string
maxLength: 0
minLength: 0
oneOfs:
- const: string
title: string
permissions: string
required: false
scope: string
title: string
type: string
union: false
unique: string
userType: string
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:
- App
Id 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"
. - Array
Enums List<string> - Array of values that an array property's items can be set to.
- Array
One List<AppOfs User Schema Property Array One Of> - Display name and value an enum array can be set to.
- Array
Type 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. - External
Name string - External name of the user schema property.
- External
Namespace 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"
. - 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 List<AppUser Schema Property One Of> - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - Unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - User
Type string - User type ID. By default, it is
default
- App
Id 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"
. - Array
Enums []string - Array of values that an array property's items can be set to.
- Array
One []AppOfs User Schema Property Array One Of Args - Display name and value an enum array can be set to.
- Array
Type 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. - External
Name string - External name of the user schema property.
- External
Namespace 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"
. - 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 []AppUser Schema Property One Of Args - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - Unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - User
Type string - User type ID. By default, it is
default
- app
Id 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"
. - array
Enums List<String> - Array of values that an array property's items can be set to.
- array
One List<AppOfs User Schema Property Array One Of> - Display name and value an enum array can be set to.
- array
Type 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. - external
Name String - External name of the user schema property.
- external
Namespace 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"
. - max
Length Integer - The maximum length of the user property value. Only applies to type
"string"
. - min
Length Integer - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs List<AppUser Schema Property One Of> - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique String
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type String - User type ID. By default, it is
default
- app
Id 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"
. - array
Enums string[] - Array of values that an array property's items can be set to.
- array
One AppOfs User Schema Property Array One Of[] - Display name and value an enum array can be set to.
- array
Type 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. - external
Name string - External name of the user schema property.
- external
Namespace 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"
. - max
Length number - The maximum length of the user property value. Only applies to type
"string"
. - min
Length number - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs AppUser Schema Property One Of[] - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type string - User type ID. By default, it is
default
- 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_ Sequence[Appofs User Schema Property Array One Of Args] - 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[AppUser Schema Property One Of Args] - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique str
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user_
type str - User type ID. By default, it is
default
- app
Id 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"
. - array
Enums List<String> - Array of values that an array property's items can be set to.
- array
One List<Property Map>Ofs - Display name and value an enum array can be set to.
- array
Type 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. - external
Name String - External name of the user schema property.
- external
Namespace 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"
. - max
Length Number - The maximum length of the user property value. Only applies to type
"string"
. - min
Length Number - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique String
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type String - User type ID. By default, it is
default
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.
- App
Id string - The Application's ID the user custom schema property should be assigned to.
- Array
Enums List<string> - Array of values that an array property's items can be set to.
- Array
One List<AppOfs User Schema Property Array One Of> - Display name and value an enum array can be set to.
- Array
Type 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. - External
Name string - External name of the user schema property.
- External
Namespace 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"
. - 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 List<AppUser Schema Property One Of> - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - Unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - User
Type string - User type ID. By default, it is
default
- App
Id string - The Application's ID the user custom schema property should be assigned to.
- Array
Enums []string - Array of values that an array property's items can be set to.
- Array
One []AppOfs User Schema Property Array One Of Args - Display name and value an enum array can be set to.
- Array
Type 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. - External
Name string - External name of the user schema property.
- External
Namespace 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"
. - 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 []AppUser Schema Property One Of Args - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - Unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - User
Type string - User type ID. By default, it is
default
- app
Id String - The Application's ID the user custom schema property should be assigned to.
- array
Enums List<String> - Array of values that an array property's items can be set to.
- array
One List<AppOfs User Schema Property Array One Of> - Display name and value an enum array can be set to.
- array
Type 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. - external
Name String - External name of the user schema property.
- external
Namespace 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"
. - max
Length Integer - The maximum length of the user property value. Only applies to type
"string"
. - min
Length Integer - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs List<AppUser Schema Property One Of> - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique String
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type String - User type ID. By default, it is
default
- app
Id string - The Application's ID the user custom schema property should be assigned to.
- array
Enums string[] - Array of values that an array property's items can be set to.
- array
One AppOfs User Schema Property Array One Of[] - Display name and value an enum array can be set to.
- array
Type 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. - external
Name string - External name of the user schema property.
- external
Namespace 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"
. - max
Length number - The maximum length of the user property value. Only applies to type
"string"
. - min
Length number - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs AppUser Schema Property One Of[] - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique string
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type string - User type ID. By default, it is
default
- 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_ Sequence[Appofs User Schema Property Array One Of Args] - 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[AppUser Schema Property One Of Args] - 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique str
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user_
type str - User type ID. By default, it is
default
- app
Id String - The Application's ID the user custom schema property should be assigned to.
- array
Enums List<String> - Array of values that an array property's items can be set to.
- array
One List<Property Map>Ofs - Display name and value an enum array can be set to.
- array
Type 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. - external
Name String - External name of the user schema property.
- external
Namespace 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"
. - max
Length Number - The maximum length of the user property value. Only applies to type
"string"
. - min
Length Number - The minimum length of the user property value. Only applies to type
"string"
. - one
Ofs 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 priorityfalse
, or combine values across groupstrue
. Can not be set totrue
ifscope
is set to"SELF"
. - unique String
- Whether the property should be unique. It can be set to
UNIQUE_VALIDATED
orNOT_UNIQUE
. - user
Type String - User type ID. By default, it is
default
Supporting Types
AppUserSchemaPropertyArrayOneOf, AppUserSchemaPropertyArrayOneOfArgs
AppUserSchemaPropertyOneOf, AppUserSchemaPropertyOneOfArgs
Import
App user schema property can be imported via the property index and app id.
$ pulumi import okta:index/appUserSchemaProperty:AppUserSchemaProperty example <app id>/<property name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
okta
Terraform Provider.