Skip to main content

Tags

User Accounts can be tagged. Tags can be used as an alternative way to group users.

A tag is a reference to a tag name.

User Accounts can have up to 100 tags each and the maximum length of each tag is 100 characters. The tags can consist of any character, but they are automatically converted to lower case, so when a tag “My_TAG“ is created, it will be converted to “my_tag“. This applies to both UI and the REST API.

Tags can be read by any user or client who has access to the user's data. Tags can be modified by users or clients with the User Modification permission. They are therefore not private to creator.

tip

You might want to use an application specific prefix for some tags. As an example, you might prefix tags related to your XYZ application like xyz_original and xyz_outdated.

Managing User tags in the UI

User Tags can be added and removed in the User Editor.

Tag editor field

Managing User tags via the REST API

Tags can be added to and removed with the /user/{userId} endpoint. See the API documentation for POST /api/rest/v1/user.