Each user in onePortal can have a number of tags, which are used by external services for various purposes.

Tags can be added and removed by using the onePortal Management UI or the REST API /user/{userId} endpoint. In the UI, the tag editor can be found in the user editor. For the latest information on the REST API endpoint, see the documentation on ${onePortalBaseURL}/apidoc3/#/Users/postNewUser and ${onePortalBaseURL}/apidoc3/#/Users/replaceUser .

Each user can have up to 100 tags assigned to them 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.

The user tags can be added and removed by any user or Management API client with the permission to modify users. Also, the user tags can be seen by any user or Management API client with permissions to view user accounts. Therefore, it should be kept in mind that the tags are visible and editable for other users and Management API clients and with suitable permissions.

It is recommended to use some application specific prefix for all the tags that are used by the application. For example, you can prefix all the tags you create with “xyz_“ so the tags will end up something like “xyz_tag1“, “xyz_another_tag” and so on. This will ensure, that there will not be confusion about which tag belongs to which application.

Because the tags are only meaningful to the external applications, you can also obfuscate the true meaning of the tag by giving it some seemingly random name. For example, the tag could simply be “xyz_8340“ and it would be difficult for anyone but its creator to tell what the tag actually means. Of course, the actual meaning should be documented somewhere in the application’s internal documentation.