Skip to main content

Tags

User accounts can be tagged — a lightweight alternative to groups for organising users. A tag is just a short reference name; a user account can have up to 100 tags, each up to 100 characters. Tags can consist of any character, but are automatically converted to lower case (both in the UI and the REST API) — for example, a tag entered as My_TAG is stored as my_tag.

Tags can be read by any user or client with access to the user's data. They can be modified by anyone with the ACCOUNT_MODIFY_CORE permission — tags are not private to whoever created them.

tip

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

Managing tags in the Management UI

Open the Accounts view, select a user, and go to the Core tab of the account editor. The Tags field lets you add tags via a combo box, and remove them by selecting the × on an existing tag chip.

Tag editor field

Managing tags via the REST API

Tags are a field on the User resource, and can be changed with a JSON Patch request:

PATCH /api/rest/v1/user/{userId}

This requires the ACCOUNT_EDIT permission together with either ACCOUNT_MODIFY or the field-specific ACCOUNT_MODIFY_CORE permission (tags is grouped under the same "core" field set as nationality, notes, and a few others). See the Management API documentation (/apidoc) for the full list of fields grouped under each ACCOUNT_MODIFY_* permission.