com.pulumi.okta.UserSchemaProperty Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.okta;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.okta.UserSchemaPropertyArgs;
import com.pulumi.okta.Utilities;
import com.pulumi.okta.inputs.UserSchemaPropertyState;
import com.pulumi.okta.outputs.UserSchemaPropertyArrayOneOf;
import com.pulumi.okta.outputs.UserSchemaPropertyMasterOverridePriority;
import com.pulumi.okta.outputs.UserSchemaPropertyOneOf;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.okta.UserSchemaProperty;
* import com.pulumi.okta.UserSchemaPropertyArgs;
* 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 UserSchemaProperty("example", UserSchemaPropertyArgs.builder()
* .index("customPropertyName")
* .title("customPropertyName")
* .type("string")
* .description("My custom property name")
* .master("OKTA")
* .scope("SELF")
* .userType(exampleOktaUserType.id())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* ```sh
* $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example <variableName>
* ```
*
* ```sh
* $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example <user_type_id>.<index>
* ```
*
*/
@ResourceType(type="okta:index/userSchemaProperty:UserSchemaProperty")
public class UserSchemaProperty extends com.pulumi.resources.CustomResource {
/**
* Array of values that an array property's items can be set to.
*
*/
@Export(name="arrayEnums", refs={List.class,String.class}, tree="[0,1]")
private Output> arrayEnums;
/**
* @return Array of values that an array property's items can be set to.
*
*/
public Output>> arrayEnums() {
return Codegen.optional(this.arrayEnums);
}
/**
* Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'
* - (Required) display name for the enum value.
*
*/
@Export(name="arrayOneOfs", refs={List.class,UserSchemaPropertyArrayOneOf.class}, tree="[0,1]")
private Output> arrayOneOfs;
/**
* @return Display name and value an enum array can be set to. - 'const' - (Required) value mapping to member of 'enum'. - 'title'
* - (Required) display name for the enum value.
*
*/
public Output>> arrayOneOfs() {
return Codegen.optional(this.arrayOneOfs);
}
/**
* The type of the array elements if `type` is set to `array`
*
*/
@Export(name="arrayType", refs={String.class}, tree="[0]")
private Output arrayType;
/**
* @return The type of the array elements if `type` is set to `array`
*
*/
public Output> arrayType() {
return Codegen.optional(this.arrayType);
}
/**
* The description of the user schema property.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description of the user schema property.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Array of values a primitive property can be set to. See `array_enum` for arrays.
*
*/
@Export(name="enums", refs={List.class,String.class}, tree="[0,1]")
private Output> enums;
/**
* @return Array of values a primitive property can be set to. See `array_enum` for arrays.
*
*/
public Output>> enums() {
return Codegen.optional(this.enums);
}
/**
* External name of the user schema property.
*
*/
@Export(name="externalName", refs={String.class}, tree="[0]")
private Output externalName;
/**
* @return External name of the user schema property.
*
*/
public Output> externalName() {
return Codegen.optional(this.externalName);
}
/**
* External namespace of the user schema property.
*
*/
@Export(name="externalNamespace", refs={String.class}, tree="[0]")
private Output externalNamespace;
/**
* @return External namespace of the user schema property.
*
*/
public Output> externalNamespace() {
return Codegen.optional(this.externalNamespace);
}
/**
* Subschema unique string identifier
*
*/
@Export(name="index", refs={String.class}, tree="[0]")
private Output index;
/**
* @return Subschema unique string identifier
*
*/
public Output index() {
return this.index;
}
/**
* Master priority for the user schema property. It can be set to `PROFILE_MASTER`, `OVERRIDE` or `OKTA`.
*
*/
@Export(name="master", refs={String.class}, tree="[0]")
private Output master;
/**
* @return Master priority for the user schema property. It can be set to `PROFILE_MASTER`, `OVERRIDE` or `OKTA`.
*
*/
public Output> master() {
return Codegen.optional(this.master);
}
/**
* Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile
* source. - 'value' - (Required) - ID of profile source.
*
*/
@Export(name="masterOverridePriorities", refs={List.class,UserSchemaPropertyMasterOverridePriority.class}, tree="[0,1]")
private Output> masterOverridePriorities;
/**
* @return Prioritized list of profile sources (required when 'master' is 'OVERRIDE'). - 'type' - (Optional) - Type of profile
* source. - 'value' - (Required) - ID of profile source.
*
*/
public Output>> masterOverridePriorities() {
return Codegen.optional(this.masterOverridePriorities);
}
/**
* The maximum length of the user property value. Only applies to type `string`
*
*/
@Export(name="maxLength", refs={Integer.class}, tree="[0]")
private Output maxLength;
/**
* @return The maximum length of the user property value. Only applies to type `string`
*
*/
public Output> maxLength() {
return Codegen.optional(this.maxLength);
}
/**
* The minimum length of the user property value. Only applies to type `string`
*
*/
@Export(name="minLength", refs={Integer.class}, tree="[0]")
private Output minLength;
/**
* @return The minimum length of the user property value. Only applies to type `string`
*
*/
public Output> minLength() {
return Codegen.optional(this.minLength);
}
/**
* Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of
* 'enum'. - 'title' - (Required) display name for the enum value.
*
*/
@Export(name="oneOfs", refs={List.class,UserSchemaPropertyOneOf.class}, tree="[0,1]")
private Output> oneOfs;
/**
* @return Array of maps containing a mapping for display name to enum value. - 'const' - (Required) value mapping to member of
* 'enum'. - 'title' - (Required) display name for the enum value.
*
*/
public Output>> oneOfs() {
return Codegen.optional(this.oneOfs);
}
/**
* The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
*
*/
@Export(name="pattern", refs={String.class}, tree="[0]")
private Output pattern;
/**
* @return The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
*
*/
public Output> pattern() {
return Codegen.optional(this.pattern);
}
/**
* Access control permissions for the property. It can be set to `READ_WRITE`, `READ_ONLY`, `HIDE`. Default: `READ_ONLY`
*
*/
@Export(name="permissions", refs={String.class}, tree="[0]")
private Output permissions;
/**
* @return Access control permissions for the property. It can be set to `READ_WRITE`, `READ_ONLY`, `HIDE`. Default: `READ_ONLY`
*
*/
public Output> permissions() {
return Codegen.optional(this.permissions);
}
/**
* Whether the subschema is required
*
*/
@Export(name="required", refs={Boolean.class}, tree="[0]")
private Output required;
/**
* @return Whether the subschema is required
*
*/
public Output> required() {
return Codegen.optional(this.required);
}
/**
* determines whether an app user attribute can be set at the Individual or Group Level. Default: `NONE`
*
*/
@Export(name="scope", refs={String.class}, tree="[0]")
private Output scope;
/**
* @return determines whether an app user attribute can be set at the Individual or Group Level. Default: `NONE`
*
*/
public Output> scope() {
return Codegen.optional(this.scope);
}
/**
* Subschema title (display name)
*
*/
@Export(name="title", refs={String.class}, tree="[0]")
private Output title;
/**
* @return Subschema title (display name)
*
*/
public Output title() {
return this.title;
}
/**
* The type of the schema property. It can be `string`, `boolean`, `number`, `integer`, `array`, or `object`
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the schema property. It can be `string`, `boolean`, `number`, `integer`, `array`, or `object`
*
*/
public Output type() {
return this.type;
}
/**
* Whether the property should be unique. It can be set to `UNIQUE_VALIDATED` or `NOT_UNIQUE`.
*
*/
@Export(name="unique", refs={String.class}, tree="[0]")
private Output unique;
/**
* @return Whether the property should be unique. It can be set to `UNIQUE_VALIDATED` or `NOT_UNIQUE`.
*
*/
public Output> unique() {
return Codegen.optional(this.unique);
}
/**
* User type ID. By default, it is `default`
*
*/
@Export(name="userType", refs={String.class}, tree="[0]")
private Output userType;
/**
* @return User type ID. By default, it is `default`
*
*/
public Output> userType() {
return Codegen.optional(this.userType);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public UserSchemaProperty(java.lang.String name) {
this(name, UserSchemaPropertyArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public UserSchemaProperty(java.lang.String name, UserSchemaPropertyArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public UserSchemaProperty(java.lang.String name, UserSchemaPropertyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("okta:index/userSchemaProperty:UserSchemaProperty", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private UserSchemaProperty(java.lang.String name, Output id, @Nullable UserSchemaPropertyState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("okta:index/userSchemaProperty:UserSchemaProperty", name, state, makeResourceOptions(options, id), false);
}
private static UserSchemaPropertyArgs makeArgs(UserSchemaPropertyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? UserSchemaPropertyArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static UserSchemaProperty get(java.lang.String name, Output id, @Nullable UserSchemaPropertyState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new UserSchemaProperty(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy