User attributes

​

Requirements

​

Creating user attributes

curl --request POST \
  --url https://{your-omni-org}.omniapp.co/api/v1/user-attributes \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "region",
  "label": "Region",
  "type": "String",
  "multiple_values": false,
  "default_value": "us-east",
  "description": "User region for row-level security filtering"
}
'

​

Assigning attributes to users

1. Navigate to Settings > Attributes.
2. Click the attribute you want to set.
3. In the attribute’s page, click the Users tab.
4. In the list of users, locate the user you want to work with. Use the toggles above the table to filter the list by:

   Filter	Description	Default
   User type	Filters users by type: Org users - Show only standard users that can log into Omni Email only - Show only email only users Embed Users - Show only embed users All - Show all users, regardless of type	Org users
   Value	Filters users by their assigned attribute value. Click the control to display condition settings: any - Show all users, regardless of value contains - Show users whose value contains the text you enter is empty - Show users with no assigned value is not empty - Show users with any assigned value	Any
   Source	Filters users by the source of their assigned attribute value: Any source - Show all users, regardless of source User setting - Show users with non-default attribute values Default setting - Show users with default attribute values	Any source

5. Click the Edit value button in user’s row.
6. In the dialog that displays, enter the value for the user.
7. Click Save.

​

Default system user attributes

​

Common questions

Can I use user attributes to control data access?

Yes. User attributes can be used in a few ways to control data access:

• Access filters, which allow you to restrict the rows of data a user can access within a topic. Access filters apply the values assigned on a user attribute to the WHERE clause of every SQL query a user runs, filtering out to only the data designated to that user:
  Filter by brand_name

  access_filters:
    - field: products.brand
      user_attribute: brand_name
      values_for_unfiltered: [all_brands]
      enable_sql_like_wildcards: true
  
• Access grants, which define topic- and field-level permissions. Omni will map a user’s attribute value to a corresponding allowed value and determine if the user has the necessary permissions to access that topic or field:
  Grant access for user group

  access_grants:
    blob_sales_access:
      user_attribute: "omni_user_groups"
      allowed_values: ["Blob Sales"]
      access_boostable: false
  
• Fields. User attributes can be referenced in fields using Mustache syntax, for example: {{ omni_attributes.<attribute-name> }}. This construct can be used to:
  • Provide conditional access to a field, or
  • To hash a field based on a user attribute. This can be done by using a CASE statement in the SQL definition for a field. For example, the following name_hidden and name_hashed examples demonstrate how to use user attributes to hide or hash a name field as an alternative to using access grants to remove access entirely:
    Hide or hash field based on user attribute

    name:
      sql: ${users.full_name}
    
    name_hidden:
      sql: |+
        CASE 
          WHEN {{omni_attributes.see_names}} = 'true'
          THEN ${users.name}
          ELSE 'No Access'
        END
    
    name_hashed:
      sql: |+
        CASE 
          WHEN {{omni_attributes.see_names}} = 'true'
          THEN ${users.name}
          ELSE MD5(${users.name})
        END
    

Can I use user attributes to dynamically change database connections?

Yes. User attributes can be used to parameterize the connection queries run against while in an Omni branch. Refer to the Dynamically switching database environments guide for more information and setup steps.

Can I use user attributes to route users to tenant-specific models?

Yes. Shared extension models use user attributes to route users to the correct model extension. You define a mapping in the parent model’s dynamic_shared_extensions parameter that links user attribute values to specific extensions.

Can I use user attributes to create dynamic content?

Yes. There are a few ways to do this:

• Dashboard Markdown tiles. You can use user attributes in dashboard Markdown tiles with Mustache syntax. For example, {{metadata.userAttributes.<user_attribute>.values}} would return the value of the specified user attribute.
• Dashboard deliveries. User attributes can be used to personalize deliveries, including messages (where supported) and the data included in the delivery.

Can I assign user attributes to email-only users?

Yes. The steps for assigning a user attribute are the same regardless of user type. To view email-only users when working with a specific attribute, click the Email Only toggle in the attribute’s Users tab:

Does Omni have any system (default) user attributes?

Yes. Refer to the Default system attributes section for more information.

Can users switch their own attribute value?

Yes, if an Organization Admin has provisioned it. See User-selected attribute values for how users switch values themselves, and how to provision which values they’re allowed to switch to.

​

Next steps

• User-selected attribute values - Let users switch their own attribute value
• Dynamic connection environments - Route users to a connection environment based on an attribute value
• User groups - Assign attributes and permissions to multiple users at once