Custom attributes

SIAM stores a number of user and organisation attributes like name, email or address. You can find an overview of all attributes under Attributes in the left menu. Here, you can see attributes organised by categories:

• User: Attributes that apply to a user profile like name and contact.
• Organisation: Attributes that apply to companies like branch offices and business address.
• Membership: User attributes in the context of an organisation like business email or phone number.

SIAM provides a list of predefined attributes that serve most cases. In addition to these predefined attributes, you can add custom attributes for each category.

Creating attributes

In SIAM, you can add attributes to customise the details you request from users and organisation. To create a custom attribute, do the following:

1. In the Attributes section, select + Create attribute at the top right.
2. In the "Create attribute" page, configure the fields according to the Attribute specifications table.
3. Click Create to create the attribute.

After you create a new attribute, you can view it in the Attributes section.

New attributes and existing profiles

When you create an attribute and set it to required, the attribute is automatically added to existing user or organisation profiles.

Attribute specifications

Field name	Description	Required	Allowed values
Type	The type of the attribute. Cannot be changed after creation.		User, Organisation, Membership.
Display name	A unique name for the attribute.		Must start with a letter. Max 128 characters long.
Property name	The key stored in the JSON object of the attribute in the API. Cannot be changed after creation.		Text
Data type	The format of the data. Cannot be changed after creation.		Can only be one of Boolean, Date, Integer, String. Learn more in the Attribute data types table below.
Default value	A suggested value displayed in the field.		Same as data type.
Required	Determines whether the attribute must have a value or can be left blank.		On/Off
Editable by admin	Determines whether an admin can edit the value of the attribute in the user profile. Applies to custom attributes only.		On/Off
Editable by user	Determines whether a user can update the value of the attribute in their profile. Applies to custom attributes only.		On/Off

Display name

Each attribute name (either custom or predefined) should be unique.

Attribute data types

Data type	Allowed values
Boolean	False,True
Date	Any date in YYYY-MM-DD format.
Integer	Positive or negative non-decimal numbers.
String	Any character, symbol or digit.