Skip to main content

UserAttribute

Information about user attribute definitions.

Properties

NameTypeDescriptionNotes
idstrThe UUID for this user attribute. Generated when the user attribute is created.[optional]
mandatoryboolA flag indicating if users must have a value for this user attribute.
namestrThe name of this user attribute.
system_definedboolA flag indicating if this user attribute is one of the system defined user attributes.
typestrType of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.[optional]
uniqueboolA flag indicating if this attribute is intended to be unique.

Example