Custom User Attributes

This article will provide you with information regarding what custom user attributes are and how to create them using Google

Please note that customer user attributes are available to recommended and custom package users.

Table of contents

  1. What are custom user attributes and how do they work?
    1. How often are custom attributes synced?
  2. How to create a custom attribute in Google
  3. How to create a custom attribute in Okta

What are custom user attributes and how do they work?

Custom attributes include additional information shown within your Happeo user profile/card aside from the standard Google Directory Fields.

This additional information allows for much richer profiles (e.g. details about interests, skill sets, preferred pronouns, etc.) and faster searches.

Furthermore, only public attributes will be displayed on Happeo while attributes only visible to administrators will not be shown.

How often are custom attributes synced?

The synchronization happens automatically every 24 hours.

How to create a custom attribute in Google

Below, you can find a tutorial from Google:

  1. You can create custom user’s attributes schema here by clicking on “Manage custom attributes”
  2. Select “Add custom attribute”
  3. Add fields into the created schema. These fields should make the organization's visible fields available only for sync and visible in Happeo 
    1. The info type should be set to “Text”
    2. The visibility should be set to “Visible to organization”
    3. The number of values should be set to “Single” or “Multiple value”
  4. By completing the previous steps, a user or administrator is then able to edit newly created fields
    1. For instance, if you navigate back to here
    2. Click on your user profile
    3. Click on the downward arrow on the right side of “User information”
    4. And scroll down until you see your recently created custom attribute
    5. You can click on the pencil/edit symbol on the right side of it (it will appear once you hover over it)
    6. And you can write whatever you like in the field
  5. After Happeo synchronizes with Google Workspace, the custom attributes become searchable and available on the user’s card. Moreover, the name of the schema becomes the section title
What Are Custom User Attributes and How to Create Them? - Google

How to create a custom attribute in Okta

From the Dashboard in Okta, click on Directory from the navigation menu and Profile editor

From the Users tab, select the Happeo App (by clicking on the application name).

Then, click on Add attribute

  • Data type – Set to string
  • Display name – The label you wish to display (e.g. skills, hobbies, favorite music genre, etc.)
  • Variable name – This is used to refer to the attribute in profile mappings and expressions (e.g. skills, hobbies, etc.)
  • External namespace – Fill in as: urn:ietf:params:scim:schemas:extension:happeo:2.0:User
  • Description – A description of the label you are displaying (e.g. the user’s skills)
  • Enum – Needs to be checked if there are only predefined fields that users can choose from (e.g. Monday, Tuesday….Sunday)
  • Attribute length – The customizable length of an attribute
  • Attribute required – Needs to be checked when creating a user or a group
  • Scope – Check the box User personal

After filling in the necessary information, you can click on Save

On the Profile editor page, you can scroll down the Attributes list to find the new attribute you created.

To add the attribute to your Happeo environment, click on Mappings under the Attributes tab. 

Then, click on Okta User to Happeo, scroll down and click on Choose an attribute or enter an expression. You can then add the mapping related to the attribute you created.

Make sure to preview the mapping to ensure that it maps properly. You can do this by entering an Okta user in the Preview field at the bottom of the page. 

Once everything looks good, you can click on Save Mappings

Note: If the User custom attribute was already filled in when you assigned the user to the app, then you need to press “Apply updates now” after you click on Save Mappings.

If users are already assigned to the Happeo app, we should receive an update from Okta as soon as you start adding values to the new attribute.

If they are not assigned to the app, we would get the whole user profile together with the custom attribute when this is synched in Happeo.

Once the users have been updated, you can find the new attributes under the Additional Info tab in the User Card. 

Note: If there are no custom attributes for a user, the Additional Info tab will not be visible.