Skip to main content

UserAttribute

Information about user attribute definitions.

Properties

NameTypeDescriptionNotes
idStringThe UUID for this user attribute. Generated when the user attribute is created.[optional]
mandatoryBooleanA flag indicating if users must have a value for this user attribute.
nameStringThe name of this user attribute.
systemDefinedBooleanA flag indicating if this user attribute is one of the system defined user attributes.
typeTypeEnumType of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.[optional]
uniqueBooleanA flag indicating if this attribute is intended to be unique.

TypeEnum

NameValue
NONE"NONE"
OTP_EMAIL"OTP_EMAIL"
OTP_SMS"OTP_SMS"
OTP_VOICE"OTP_VOICE"