Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. UserPropertySettings
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.UserPropertySettings

Explore with Pulumi AI

propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

User Property Settings. User properties are fields that you can use to store information about your users. You can use them to collect information about your users on sign up, like their name or how they heard about your product. You can also use them to store information about your users as they use your product, like their subscription status, external IDs, or just arbitrary JSON data.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.UserPropertySettings;
import com.pulumi.propelauth.UserPropertySettingsArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsCustomPropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsMetadataPropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsNamePropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsPhoneNumberPropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsReferralSourcePropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsTosPropertyArgs;
import com.pulumi.propelauth.inputs.UserPropertySettingsUsernamePropertyArgs;
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) {
        // Configure all the properties that can be set on a user in your PropelAuth project.
        var example = new UserPropertySettings("example", UserPropertySettingsArgs.builder()
            .customProperties(            
                UserPropertySettingsCustomPropertyArgs.builder()
                    .displayName("Birthday")
                    .fieldType("Date")
                    .inJwt(true)
                    .name("birthday")
                    .required(false)
                    .userWritable("Write")
                    .build(),
                UserPropertySettingsCustomPropertyArgs.builder()
                    .displayName("Favorite Ice Cream Flavor")
                    .enumValues(                    
                        "Vanilla",
                        "Chocolate",
                        "Strawberry",
                        "Mint Chocolate Chip",
                        "Other")
                    .fieldType("Enum")
                    .inJwt(true)
                    .name("favorite_ice_cream_flavor")
                    .required(true)
                    .requiredBy(0)
                    .userWritable("Write")
                    .build(),
                UserPropertySettingsCustomPropertyArgs.builder()
                    .displayName("Favorite Color")
                    .fieldType("Text")
                    .inJwt(false)
                    .name("favorite_color")
                    .required(false)
                    .userWritable("Write")
                    .build(),
                UserPropertySettingsCustomPropertyArgs.builder()
                    .displayName("I want to receive the newsletter")
                    .fieldType("Toggle")
                    .name("receive_newsletter")
                    .showInAccount(false)
                    .userWritable("Write")
                    .build())
            .metadataProperty(UserPropertySettingsMetadataPropertyArgs.builder()
                .in_jwt(true)
                .build())
            .nameProperty(UserPropertySettingsNamePropertyArgs.builder()
                .in_jwt(false)
                .build())
            .phoneNumberProperty(UserPropertySettingsPhoneNumberPropertyArgs.builder()
                .collect_via_saml(true)
                .in_jwt(false)
                .required(true)
                .required_by(0)
                .show_in_account(true)
                .user_writable("Write")
                .build())
            .referralSourceProperty(UserPropertySettingsReferralSourcePropertyArgs.builder()
                .display_name("How did you find my awesome app?")
                .in_jwt(false)
                .options(                
                    "Google",
                    "Facebook",
                    "Twitter",
                    "LinkedIn",
                    "Other")
                .required(true)
                .required_by(0)
                .user_writable("WriteIfUnset")
                .build())
            .tosProperty(UserPropertySettingsTosPropertyArgs.builder()
                .in_jwt(false)
                .required(true)
                .required_by(0)
                .tos_links(                
                    %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                    %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .user_writable("Write")
                .build())
            .usernameProperty(UserPropertySettingsUsernamePropertyArgs.builder()
                .display_name("Account Name")
                .in_jwt(true)
                .build())
            .build());

    }
}
Copy
resources:
  # Configure all the properties that can be set on a user in your PropelAuth project.
  example:
    type: propelauth:UserPropertySettings
    properties:
      customProperties:
        - displayName: Birthday
          fieldType: Date
          inJwt: true
          name: birthday
          required: false
          userWritable: Write
        - displayName: Favorite Ice Cream Flavor
          enumValues:
            - Vanilla
            - Chocolate
            - Strawberry
            - Mint Chocolate Chip
            - Other
          fieldType: Enum
          inJwt: true
          name: favorite_ice_cream_flavor
          required: true
          requiredBy: 0
          userWritable: Write
        - displayName: Favorite Color
          fieldType: Text
          inJwt: false
          name: favorite_color
          required: false
          userWritable: Write
        - displayName: I want to receive the newsletter
          fieldType: Toggle
          name: receive_newsletter
          showInAccount: false
          userWritable: Write
      metadataProperty:
        in_jwt: true
      nameProperty:
        in_jwt: false
      # picture_url_property = {} # leaving this unset unsures the property remains disabled
      phoneNumberProperty:
        collect_via_saml: true
        in_jwt: false
        required: true
        required_by: 0
        show_in_account: true
        user_writable: Write
      referralSourceProperty:
        display_name: How did you find my awesome app?
        in_jwt: false
        options:
          - Google
          - Facebook
          - Twitter
          - LinkedIn
          - Other
        required: true
        required_by: 0
        user_writable: WriteIfUnset
      tosProperty:
        in_jwt: false
        required: true
        required_by: 0
        tos_links:
          - name: Terms of Service
            url: https://example.com/tos
          - name: Privacy Policy
            url: https://example.com/privacy
        user_writable: Write
      usernameProperty:
        display_name: Account Name
        in_jwt: true
Copy

Create UserPropertySettings Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserPropertySettings(name: string, args?: UserPropertySettingsArgs, opts?: CustomResourceOptions);
@overload
def UserPropertySettings(resource_name: str,
                         args: Optional[UserPropertySettingsArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def UserPropertySettings(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         custom_properties: Optional[Sequence[UserPropertySettingsCustomPropertyArgs]] = None,
                         metadata_property: Optional[UserPropertySettingsMetadataPropertyArgs] = None,
                         name_property: Optional[UserPropertySettingsNamePropertyArgs] = None,
                         phone_number_property: Optional[UserPropertySettingsPhoneNumberPropertyArgs] = None,
                         picture_url_property: Optional[UserPropertySettingsPictureUrlPropertyArgs] = None,
                         referral_source_property: Optional[UserPropertySettingsReferralSourcePropertyArgs] = None,
                         tos_property: Optional[UserPropertySettingsTosPropertyArgs] = None,
                         username_property: Optional[UserPropertySettingsUsernamePropertyArgs] = None)
func NewUserPropertySettings(ctx *Context, name string, args *UserPropertySettingsArgs, opts ...ResourceOption) (*UserPropertySettings, error)
public UserPropertySettings(string name, UserPropertySettingsArgs? args = null, CustomResourceOptions? opts = null)
public UserPropertySettings(String name, UserPropertySettingsArgs args)
public UserPropertySettings(String name, UserPropertySettingsArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args UserPropertySettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args UserPropertySettingsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args UserPropertySettingsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args UserPropertySettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserPropertySettingsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var userPropertySettingsResource = new Propelauth.UserPropertySettings("userPropertySettingsResource", new()
{
    CustomProperties = new[]
    {
        new Propelauth.Inputs.UserPropertySettingsCustomPropertyArgs
        {
            DisplayName = "string",
            FieldType = "string",
            Name = "string",
            CollectOnSignup = false,
            CollectViaSaml = false,
            EnumValues = new[]
            {
                "string",
            },
            InJwt = false,
            IsUserFacing = false,
            Required = false,
            RequiredBy = 0,
            ShowInAccount = false,
            UserWritable = "string",
        },
    },
    MetadataProperty = new Propelauth.Inputs.UserPropertySettingsMetadataPropertyArgs
    {
        CollectViaSaml = false,
        InJwt = false,
    },
    NameProperty = new Propelauth.Inputs.UserPropertySettingsNamePropertyArgs
    {
        InJwt = false,
    },
    PhoneNumberProperty = new Propelauth.Inputs.UserPropertySettingsPhoneNumberPropertyArgs
    {
        CollectViaSaml = false,
        DisplayName = "string",
        InJwt = false,
        Required = false,
        RequiredBy = 0,
        ShowInAccount = false,
        UserWritable = "string",
    },
    PictureUrlProperty = new Propelauth.Inputs.UserPropertySettingsPictureUrlPropertyArgs
    {
        InJwt = false,
    },
    ReferralSourceProperty = new Propelauth.Inputs.UserPropertySettingsReferralSourcePropertyArgs
    {
        CollectViaSaml = false,
        DisplayName = "string",
        InJwt = false,
        Options = new[]
        {
            "string",
        },
        Required = false,
        RequiredBy = 0,
        ShowInAccount = false,
        UserWritable = "string",
    },
    TosProperty = new Propelauth.Inputs.UserPropertySettingsTosPropertyArgs
    {
        InJwt = false,
        Required = false,
        RequiredBy = 0,
        TosLinks = new[]
        {
            new Propelauth.Inputs.UserPropertySettingsTosPropertyTosLinkArgs
            {
                Name = "string",
                Url = "string",
            },
        },
    },
    UsernameProperty = new Propelauth.Inputs.UserPropertySettingsUsernamePropertyArgs
    {
        DisplayName = "string",
        InJwt = false,
    },
});
Copy
example, err := propelauth.NewUserPropertySettings(ctx, "userPropertySettingsResource", &propelauth.UserPropertySettingsArgs{
CustomProperties: .UserPropertySettingsCustomPropertyArray{
&.UserPropertySettingsCustomPropertyArgs{
DisplayName: pulumi.String("string"),
FieldType: pulumi.String("string"),
Name: pulumi.String("string"),
CollectOnSignup: pulumi.Bool(false),
CollectViaSaml: pulumi.Bool(false),
EnumValues: pulumi.StringArray{
pulumi.String("string"),
},
InJwt: pulumi.Bool(false),
IsUserFacing: pulumi.Bool(false),
Required: pulumi.Bool(false),
RequiredBy: pulumi.Float64(0),
ShowInAccount: pulumi.Bool(false),
UserWritable: pulumi.String("string"),
},
},
MetadataProperty: &.UserPropertySettingsMetadataPropertyArgs{
CollectViaSaml: pulumi.Bool(false),
InJwt: pulumi.Bool(false),
},
NameProperty: &.UserPropertySettingsNamePropertyArgs{
InJwt: pulumi.Bool(false),
},
PhoneNumberProperty: &.UserPropertySettingsPhoneNumberPropertyArgs{
CollectViaSaml: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
InJwt: pulumi.Bool(false),
Required: pulumi.Bool(false),
RequiredBy: pulumi.Float64(0),
ShowInAccount: pulumi.Bool(false),
UserWritable: pulumi.String("string"),
},
PictureUrlProperty: &.UserPropertySettingsPictureUrlPropertyArgs{
InJwt: pulumi.Bool(false),
},
ReferralSourceProperty: &.UserPropertySettingsReferralSourcePropertyArgs{
CollectViaSaml: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
InJwt: pulumi.Bool(false),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Required: pulumi.Bool(false),
RequiredBy: pulumi.Float64(0),
ShowInAccount: pulumi.Bool(false),
UserWritable: pulumi.String("string"),
},
TosProperty: &.UserPropertySettingsTosPropertyArgs{
InJwt: pulumi.Bool(false),
Required: pulumi.Bool(false),
RequiredBy: pulumi.Float64(0),
TosLinks: .UserPropertySettingsTosPropertyTosLinkArray{
&.UserPropertySettingsTosPropertyTosLinkArgs{
Name: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
},
UsernameProperty: &.UserPropertySettingsUsernamePropertyArgs{
DisplayName: pulumi.String("string"),
InJwt: pulumi.Bool(false),
},
})
Copy
var userPropertySettingsResource = new UserPropertySettings("userPropertySettingsResource", UserPropertySettingsArgs.builder()
    .customProperties(UserPropertySettingsCustomPropertyArgs.builder()
        .displayName("string")
        .fieldType("string")
        .name("string")
        .collectOnSignup(false)
        .collectViaSaml(false)
        .enumValues("string")
        .inJwt(false)
        .isUserFacing(false)
        .required(false)
        .requiredBy(0)
        .showInAccount(false)
        .userWritable("string")
        .build())
    .metadataProperty(UserPropertySettingsMetadataPropertyArgs.builder()
        .collectViaSaml(false)
        .inJwt(false)
        .build())
    .nameProperty(UserPropertySettingsNamePropertyArgs.builder()
        .inJwt(false)
        .build())
    .phoneNumberProperty(UserPropertySettingsPhoneNumberPropertyArgs.builder()
        .collectViaSaml(false)
        .displayName("string")
        .inJwt(false)
        .required(false)
        .requiredBy(0)
        .showInAccount(false)
        .userWritable("string")
        .build())
    .pictureUrlProperty(UserPropertySettingsPictureUrlPropertyArgs.builder()
        .inJwt(false)
        .build())
    .referralSourceProperty(UserPropertySettingsReferralSourcePropertyArgs.builder()
        .collectViaSaml(false)
        .displayName("string")
        .inJwt(false)
        .options("string")
        .required(false)
        .requiredBy(0)
        .showInAccount(false)
        .userWritable("string")
        .build())
    .tosProperty(UserPropertySettingsTosPropertyArgs.builder()
        .inJwt(false)
        .required(false)
        .requiredBy(0)
        .tosLinks(UserPropertySettingsTosPropertyTosLinkArgs.builder()
            .name("string")
            .url("string")
            .build())
        .build())
    .usernameProperty(UserPropertySettingsUsernamePropertyArgs.builder()
        .displayName("string")
        .inJwt(false)
        .build())
    .build());
Copy
user_property_settings_resource = propelauth.UserPropertySettings("userPropertySettingsResource",
    custom_properties=[{
        "display_name": "string",
        "field_type": "string",
        "name": "string",
        "collect_on_signup": False,
        "collect_via_saml": False,
        "enum_values": ["string"],
        "in_jwt": False,
        "is_user_facing": False,
        "required": False,
        "required_by": 0,
        "show_in_account": False,
        "user_writable": "string",
    }],
    metadata_property={
        "collect_via_saml": False,
        "in_jwt": False,
    },
    name_property={
        "in_jwt": False,
    },
    phone_number_property={
        "collect_via_saml": False,
        "display_name": "string",
        "in_jwt": False,
        "required": False,
        "required_by": 0,
        "show_in_account": False,
        "user_writable": "string",
    },
    picture_url_property={
        "in_jwt": False,
    },
    referral_source_property={
        "collect_via_saml": False,
        "display_name": "string",
        "in_jwt": False,
        "options": ["string"],
        "required": False,
        "required_by": 0,
        "show_in_account": False,
        "user_writable": "string",
    },
    tos_property={
        "in_jwt": False,
        "required": False,
        "required_by": 0,
        "tos_links": [{
            "name": "string",
            "url": "string",
        }],
    },
    username_property={
        "display_name": "string",
        "in_jwt": False,
    })
Copy
const userPropertySettingsResource = new propelauth.UserPropertySettings("userPropertySettingsResource", {
    customProperties: [{
        displayName: "string",
        fieldType: "string",
        name: "string",
        collectOnSignup: false,
        collectViaSaml: false,
        enumValues: ["string"],
        inJwt: false,
        isUserFacing: false,
        required: false,
        requiredBy: 0,
        showInAccount: false,
        userWritable: "string",
    }],
    metadataProperty: {
        collectViaSaml: false,
        inJwt: false,
    },
    nameProperty: {
        inJwt: false,
    },
    phoneNumberProperty: {
        collectViaSaml: false,
        displayName: "string",
        inJwt: false,
        required: false,
        requiredBy: 0,
        showInAccount: false,
        userWritable: "string",
    },
    pictureUrlProperty: {
        inJwt: false,
    },
    referralSourceProperty: {
        collectViaSaml: false,
        displayName: "string",
        inJwt: false,
        options: ["string"],
        required: false,
        requiredBy: 0,
        showInAccount: false,
        userWritable: "string",
    },
    tosProperty: {
        inJwt: false,
        required: false,
        requiredBy: 0,
        tosLinks: [{
            name: "string",
            url: "string",
        }],
    },
    usernameProperty: {
        displayName: "string",
        inJwt: false,
    },
});
Copy
type: propelauth:UserPropertySettings
properties:
    customProperties:
        - collectOnSignup: false
          collectViaSaml: false
          displayName: string
          enumValues:
            - string
          fieldType: string
          inJwt: false
          isUserFacing: false
          name: string
          required: false
          requiredBy: 0
          showInAccount: false
          userWritable: string
    metadataProperty:
        collectViaSaml: false
        inJwt: false
    nameProperty:
        inJwt: false
    phoneNumberProperty:
        collectViaSaml: false
        displayName: string
        inJwt: false
        required: false
        requiredBy: 0
        showInAccount: false
        userWritable: string
    pictureUrlProperty:
        inJwt: false
    referralSourceProperty:
        collectViaSaml: false
        displayName: string
        inJwt: false
        options:
            - string
        required: false
        requiredBy: 0
        showInAccount: false
        userWritable: string
    tosProperty:
        inJwt: false
        required: false
        requiredBy: 0
        tosLinks:
            - name: string
              url: string
    usernameProperty:
        displayName: string
        inJwt: false
Copy

UserPropertySettings Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserPropertySettings resource accepts the following input properties:

CustomProperties List<UserPropertySettingsCustomProperty>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
MetadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
NameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
PhoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
PictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
ReferralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
TosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
UsernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
CustomProperties []UserPropertySettingsCustomPropertyArgs
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
MetadataProperty UserPropertySettingsMetadataPropertyArgs
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
NameProperty UserPropertySettingsNamePropertyArgs
Settings for the user's name property. If no block is provided, the name property will be disabled.
PhoneNumberProperty UserPropertySettingsPhoneNumberPropertyArgs
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
PictureUrlProperty UserPropertySettingsPictureUrlPropertyArgs
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
ReferralSourceProperty UserPropertySettingsReferralSourcePropertyArgs
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
TosProperty UserPropertySettingsTosPropertyArgs
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
UsernameProperty UserPropertySettingsUsernamePropertyArgs
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties List<UserPropertySettingsCustomProperty>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties UserPropertySettingsCustomProperty[]
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
custom_properties Sequence[UserPropertySettingsCustomPropertyArgs]
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadata_property UserPropertySettingsMetadataPropertyArgs
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
name_property UserPropertySettingsNamePropertyArgs
Settings for the user's name property. If no block is provided, the name property will be disabled.
phone_number_property UserPropertySettingsPhoneNumberPropertyArgs
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
picture_url_property UserPropertySettingsPictureUrlPropertyArgs
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referral_source_property UserPropertySettingsReferralSourcePropertyArgs
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tos_property UserPropertySettingsTosPropertyArgs
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
username_property UserPropertySettingsUsernamePropertyArgs
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties List<Property Map>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty Property Map
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty Property Map
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty Property Map
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty Property Map
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty Property Map
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty Property Map
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty Property Map
Settings for the user's username property. If no block is provided, the username property will be disabled.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPropertySettings 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 UserPropertySettings Resource

Get an existing UserPropertySettings 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?: UserPropertySettingsState, opts?: CustomResourceOptions): UserPropertySettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_properties: Optional[Sequence[UserPropertySettingsCustomPropertyArgs]] = None,
        metadata_property: Optional[UserPropertySettingsMetadataPropertyArgs] = None,
        name_property: Optional[UserPropertySettingsNamePropertyArgs] = None,
        phone_number_property: Optional[UserPropertySettingsPhoneNumberPropertyArgs] = None,
        picture_url_property: Optional[UserPropertySettingsPictureUrlPropertyArgs] = None,
        referral_source_property: Optional[UserPropertySettingsReferralSourcePropertyArgs] = None,
        tos_property: Optional[UserPropertySettingsTosPropertyArgs] = None,
        username_property: Optional[UserPropertySettingsUsernamePropertyArgs] = None) -> UserPropertySettings
func GetUserPropertySettings(ctx *Context, name string, id IDInput, state *UserPropertySettingsState, opts ...ResourceOption) (*UserPropertySettings, error)
public static UserPropertySettings Get(string name, Input<string> id, UserPropertySettingsState? state, CustomResourceOptions? opts = null)
public static UserPropertySettings get(String name, Output<String> id, UserPropertySettingsState state, CustomResourceOptions options)
resources:  _:    type: propelauth:UserPropertySettings    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CustomProperties List<UserPropertySettingsCustomProperty>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
MetadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
NameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
PhoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
PictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
ReferralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
TosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
UsernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
CustomProperties []UserPropertySettingsCustomPropertyArgs
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
MetadataProperty UserPropertySettingsMetadataPropertyArgs
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
NameProperty UserPropertySettingsNamePropertyArgs
Settings for the user's name property. If no block is provided, the name property will be disabled.
PhoneNumberProperty UserPropertySettingsPhoneNumberPropertyArgs
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
PictureUrlProperty UserPropertySettingsPictureUrlPropertyArgs
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
ReferralSourceProperty UserPropertySettingsReferralSourcePropertyArgs
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
TosProperty UserPropertySettingsTosPropertyArgs
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
UsernameProperty UserPropertySettingsUsernamePropertyArgs
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties List<UserPropertySettingsCustomProperty>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties UserPropertySettingsCustomProperty[]
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty UserPropertySettingsMetadataProperty
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty UserPropertySettingsNameProperty
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty UserPropertySettingsPhoneNumberProperty
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty UserPropertySettingsPictureUrlProperty
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty UserPropertySettingsReferralSourceProperty
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty UserPropertySettingsTosProperty
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty UserPropertySettingsUsernameProperty
Settings for the user's username property. If no block is provided, the username property will be disabled.
custom_properties Sequence[UserPropertySettingsCustomPropertyArgs]
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadata_property UserPropertySettingsMetadataPropertyArgs
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
name_property UserPropertySettingsNamePropertyArgs
Settings for the user's name property. If no block is provided, the name property will be disabled.
phone_number_property UserPropertySettingsPhoneNumberPropertyArgs
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
picture_url_property UserPropertySettingsPictureUrlPropertyArgs
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referral_source_property UserPropertySettingsReferralSourcePropertyArgs
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tos_property UserPropertySettingsTosPropertyArgs
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
username_property UserPropertySettingsUsernamePropertyArgs
Settings for the user's username property. If no block is provided, the username property will be disabled.
customProperties List<Property Map>
Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans.
metadataProperty Property Map
Settings for the user's metadata property. If no block is provided, the metadata property will be disabled.
nameProperty Property Map
Settings for the user's name property. If no block is provided, the name property will be disabled.
phoneNumberProperty Property Map
Settings for the user's phone number property. If no block is provided, the phone number property will be disabled.
pictureUrlProperty Property Map
Settings for the user's picture URL property. If no block is provided, the picture URL property will be disabled.
referralSourceProperty Property Map
Settings for the user's referral source property. If no block is provided, the referral source property will be disabled.
tosProperty Property Map
Settings for the user's Terms of Service property. If no block is provided, the terms of service property will be disabled.
usernameProperty Property Map
Settings for the user's username property. If no block is provided, the username property will be disabled.

Supporting Types

UserPropertySettingsCustomProperty
, UserPropertySettingsCustomPropertyArgs

DisplayName This property is required. string
The field name users see in the UI for the property.
FieldType This property is required. string
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
Name This property is required. string
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
CollectOnSignup bool
Whether the property should be collected from new users during the sign up flow. The default value is true.
CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
EnumValues List<string>
A list of possible values for the property. This is only required for the Enum field type.
InJwt bool
Whether the property should be included in the user token. The default value is true.
IsUserFacing bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write
DisplayName This property is required. string
The field name users see in the UI for the property.
FieldType This property is required. string
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
Name This property is required. string
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
CollectOnSignup bool
Whether the property should be collected from new users during the sign up flow. The default value is true.
CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
EnumValues []string
A list of possible values for the property. This is only required for the Enum field type.
InJwt bool
Whether the property should be included in the user token. The default value is true.
IsUserFacing bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy float64
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write
displayName This property is required. String
The field name users see in the UI for the property.
fieldType This property is required. String
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
name This property is required. String
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
collectOnSignup Boolean
Whether the property should be collected from new users during the sign up flow. The default value is true.
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
enumValues List<String>
A list of possible values for the property. This is only required for the Enum field type.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
isUserFacing Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write
displayName This property is required. string
The field name users see in the UI for the property.
fieldType This property is required. string
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
name This property is required. string
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
collectOnSignup boolean
Whether the property should be collected from new users during the sign up flow. The default value is true.
collectViaSaml boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
enumValues string[]
A list of possible values for the property. This is only required for the Enum field type.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
isUserFacing boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
required boolean
Whether the property is required for users. The default value is true.
requiredBy number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
userWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write
display_name This property is required. str
The field name users see in the UI for the property.
field_type This property is required. str
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
name This property is required. str
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
collect_on_signup bool
Whether the property should be collected from new users during the sign up flow. The default value is true.
collect_via_saml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
enum_values Sequence[str]
A list of possible values for the property. This is only required for the Enum field type.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
is_user_facing bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
required bool
Whether the property is required for users. The default value is true.
required_by float
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
show_in_account bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
user_writable str
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write
displayName This property is required. String
The field name users see in the UI for the property.
fieldType This property is required. String
The type of the field. Accepted values are Checkbox, Date, Enum, Integer, Json, LongText, Text, Toggle, and Url. Once set, this cannot be changed.
name This property is required. String
The field name used to identify the property in the API and SDKs (e.g. external_id). It cannot be changed after creation.
collectOnSignup Boolean
Whether the property should be collected from new users during the sign up flow. The default value is true.
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
enumValues List<String>
A list of possible values for the property. This is only required for the Enum field type.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
isUserFacing Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is true.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is Write

UserPropertySettingsMetadataProperty
, UserPropertySettingsMetadataPropertyArgs

CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
InJwt bool
Whether the property should be included in the user token. The default value is true.
CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
InJwt bool
Whether the property should be included in the user token. The default value is true.
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
collectViaSaml boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
collect_via_saml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.

UserPropertySettingsNameProperty
, UserPropertySettingsNamePropertyArgs

InJwt bool
Whether the property should be included in the user token. The default value is true.
InJwt bool
Whether the property should be included in the user token. The default value is true.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.

UserPropertySettingsPhoneNumberProperty
, UserPropertySettingsPhoneNumberPropertyArgs

CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
DisplayName string
The field name users see in the UI for the property. The default value is Phone number.
InJwt bool
Whether the property should be included in the user token. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
DisplayName string
The field name users see in the UI for the property. The default value is Phone number.
InJwt bool
Whether the property should be included in the user token. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy float64
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName String
The field name users see in the UI for the property. The default value is Phone number.
inJwt Boolean
Whether the property should be included in the user token. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName string
The field name users see in the UI for the property. The default value is Phone number.
inJwt boolean
Whether the property should be included in the user token. The default value is false.
required boolean
Whether the property is required for users. The default value is true.
requiredBy number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collect_via_saml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
display_name str
The field name users see in the UI for the property. The default value is Phone number.
in_jwt bool
Whether the property should be included in the user token. The default value is false.
required bool
Whether the property is required for users. The default value is true.
required_by float
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
show_in_account bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
user_writable str
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName String
The field name users see in the UI for the property. The default value is Phone number.
inJwt Boolean
Whether the property should be included in the user token. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset

UserPropertySettingsPictureUrlProperty
, UserPropertySettingsPictureUrlPropertyArgs

InJwt bool
Whether the property should be included in the user token. The default value is true.
InJwt bool
Whether the property should be included in the user token. The default value is true.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.

UserPropertySettingsReferralSourceProperty
, UserPropertySettingsReferralSourcePropertyArgs

CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
DisplayName string
The field name users see in the UI for the property. The default value is How did you hear about us?.
InJwt bool
Whether the property should be included in the user token. The default value is true.
Options List<string>
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
CollectViaSaml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
DisplayName string
The field name users see in the UI for the property. The default value is How did you hear about us?.
InJwt bool
Whether the property should be included in the user token. The default value is true.
Options []string
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy float64
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
ShowInAccount bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
UserWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName String
The field name users see in the UI for the property. The default value is How did you hear about us?.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
options List<String>
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName string
The field name users see in the UI for the property. The default value is How did you hear about us?.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
options string[]
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
required boolean
Whether the property is required for users. The default value is true.
requiredBy number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable string
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collect_via_saml bool
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
display_name str
The field name users see in the UI for the property. The default value is How did you hear about us?.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
options Sequence[str]
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
required bool
Whether the property is required for users. The default value is true.
required_by float
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
show_in_account bool
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
user_writable str
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset
collectViaSaml Boolean
Whether the property should be collected for users during the enterprise SSO login flow. The default value is false.
displayName String
The field name users see in the UI for the property. The default value is How did you hear about us?.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
options List<String>
A list of options for the referral source property. If this is unset, the default options will be used. These are Search engine, Recommendation, Social media, Blog post, Other.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
showInAccount Boolean
Whether the property should be displayed in the user's account page hosted by PropelAuth. The default value is false.
userWritable String
This setting determines whether the user can edit the value of the property and how many times. Options are Write, Read, and WriteIfUnset. The default value is WriteIfUnset

UserPropertySettingsTosProperty
, UserPropertySettingsTosPropertyArgs

InJwt bool
Whether the property should be included in the user token. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
TosLinks List<UserPropertySettingsTosPropertyTosLink>
A list of Terms of Service links. Each link must have a URL and a name.
InJwt bool
Whether the property should be included in the user token. The default value is false.
Required bool
Whether the property is required for users. The default value is true.
RequiredBy float64
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
TosLinks []UserPropertySettingsTosPropertyTosLink
A list of Terms of Service links. Each link must have a URL and a name.
inJwt Boolean
Whether the property should be included in the user token. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Double
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
tosLinks List<UserPropertySettingsTosPropertyTosLink>
A list of Terms of Service links. Each link must have a URL and a name.
inJwt boolean
Whether the property should be included in the user token. The default value is false.
required boolean
Whether the property is required for users. The default value is true.
requiredBy number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
tosLinks UserPropertySettingsTosPropertyTosLink[]
A list of Terms of Service links. Each link must have a URL and a name.
in_jwt bool
Whether the property should be included in the user token. The default value is false.
required bool
Whether the property is required for users. The default value is true.
required_by float
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
tos_links Sequence[UserPropertySettingsTosPropertyTosLink]
A list of Terms of Service links. Each link must have a URL and a name.
inJwt Boolean
Whether the property should be included in the user token. The default value is false.
required Boolean
Whether the property is required for users. The default value is true.
requiredBy Number
In epoch time. Only accounts created after this time are required to provide this field. For example, a value of 0 means all accounts are required to provide this field. The default value is 0.
tosLinks List<Property Map>
A list of Terms of Service links. Each link must have a URL and a name.
Name This property is required. string
The name of the Terms of Service link.
Url This property is required. string
The URL of the Terms of Service link.
Name This property is required. string
The name of the Terms of Service link.
Url This property is required. string
The URL of the Terms of Service link.
name This property is required. String
The name of the Terms of Service link.
url This property is required. String
The URL of the Terms of Service link.
name This property is required. string
The name of the Terms of Service link.
url This property is required. string
The URL of the Terms of Service link.
name This property is required. str
The name of the Terms of Service link.
url This property is required. str
The URL of the Terms of Service link.
name This property is required. String
The name of the Terms of Service link.
url This property is required. String
The URL of the Terms of Service link.

UserPropertySettingsUsernameProperty
, UserPropertySettingsUsernamePropertyArgs

DisplayName string
The field name users see in the UI for the property. The default value is Username.
InJwt bool
Whether the property should be included in the user token. The default value is true.
DisplayName string
The field name users see in the UI for the property. The default value is Username.
InJwt bool
Whether the property should be included in the user token. The default value is true.
displayName String
The field name users see in the UI for the property. The default value is Username.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.
displayName string
The field name users see in the UI for the property. The default value is Username.
inJwt boolean
Whether the property should be included in the user token. The default value is true.
display_name str
The field name users see in the UI for the property. The default value is Username.
in_jwt bool
Whether the property should be included in the user token. The default value is true.
displayName String
The field name users see in the UI for the property. The default value is Username.
inJwt Boolean
Whether the property should be included in the user token. The default value is true.

Import

As there is only one user_property_settings per project there’s no need to specify the id,

$ pulumi import propelauth:index/userPropertySettings:UserPropertySettings but requires an id to be specified, so we can use an arbitrary string here.
Copy
$ pulumi import propelauth:index/userPropertySettings:UserPropertySettings example arbitrary_string_here
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
propelauth propelauth/terraform-provider-propelauth
License
Notes
This Pulumi package is based on the propelauth Terraform Provider.
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth