This is a preview of unreleased docs from main. View the published docs
Skip to main content

Type Alias: UserAttributeValue

UserAttributeValue = object

Defined in: types.ts:1121

A single user attribute defined by the organization, together with the authenticated member's current value (null when the member has not set it). Attributes the organization marked private are never returned here.

Properties​

PropertyTypeDescriptionDefined in
descriptionstring | null-types.ts:1124
namestring-types.ts:1123
optionsstring[] | null-types.ts:1126
privatebooleanAlways false here: private attributes are not exposed to the session API.types.ts:1131
slugstring-types.ts:1122
typestring-types.ts:1125
user_editablebooleanWhether the member may update this attribute through the session API.types.ts:1129
validation_rulesUserAttributeValidationRule[] | null-types.ts:1132
valueunknown-types.ts:1127