User groups
A group of users, such as a team or a department. Members are listed in user_refs, administrators in admin_refs, and the spaces and documents a group can open are given by tree_entity_roles with the group as member_ref. A group with the same name already in the target is reused, and names are distinct without regard to case. A reused group keeps its own members and administrators: user_refs and admin_refs are added only to groups the import creates, and the import reports the ones it skipped. A package with groups or roles of your own can be imported only by a user with the Members management permission, and only if the tariff includes groups.
A record of this entity needs records of other entities in the package: Users.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "user_groups". An entity can have any number of files. See Bundle format.
[
{
"resource": "user_groups",
"path": "resources/user_groups.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
name | string | Yes | Name of the group, for example Analytics team. Up to 512 characters; names are distinct without regard to case.Constraints: 1–512 characters. Rule: Unique without regard to case. |
user_refs | Ref<users>[] refers to Users | Yes | The members of the group, at least one, by the external_id of users records, for example ["u-ava", "u-liam"]. Each user at most once. A group without members gives nobody access, so leave such a group out of the package.Constraints: items are unique. |
add_to_cards_and_spaces_enabled | boolean? | No | Whether all members of the group can be added to cards at once in the spaces the group can open, and logged time can be filtered by the group in timesheets. Leave it out for the default of the target. |
admin_refs | Ref<users>[] refers to Users | No | The administrators of the group, by the external_id of users records. An administrator does not have to be a member; list the user in user_refs too for membership. Each user at most once.Constraints: items are unique. Default: |
References
Show on the entity map
Example
A record of this entity:
{
"external_id": "g-analytics",
"name": "Analytics team",
"add_to_cards_and_spaces_enabled": true,
"user_refs": [
"u-ava",
"u-liam",
"u-noor"
],
"admin_refs": [
"u-ava"
]
}Rules
- The value of name must be unique without regard to case.
Related entities
Tree entity roles, Users
Check after the import
After the import, the records of this entity can be checked on Groups › Get list of groups.
JSON Schema
user_groups.json
