propelauth.UserPropertySettings

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

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

The unique name of the resource.

args UserPropertySettingsArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

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.

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.

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.

DisplayName string

The field name users see in the UI for the property.

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

The field name users see in the UI for the property.

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

The field name users see in the UI for the property.

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

The field name users see in the UI for the property.

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

The field name users see in the UI for the property.

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

The field name users see in the UI for the property.

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

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.

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.

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

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.

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

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.