User group (group)

Description

Defines role sets. Includes users. Can include other groups (without cycles).
When groups are configured, it is enough to include a user in one of them; roles are determined automatically.
However, the administrator role (admin) must be assigned directly to at least one user of the domain.

Fields

Entity structure
{
  "id": uuid,
  "code": str,
  "description": str,
  "users": array<str>,
  "groups": array<str>,
  "opts": {
    "title": str,
    "comment": str,
    "roles": array<str>
  },
  "security": object,
  "ext": {
    "ct": date,
    "lwt": date
  }
}
Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: code
Mode: in
Type: str
Default: required

String group code

Field: description
Mode: in
Type: str
Default: empty

Description

Field: users
Mode: in
Type: array
Default: empty

List of users belonging to the group. Specified by identifiers.
Via the API, logins can be specified at creation and are automatically expanded to identifiers.

Field: groups
Mode: in
Type: array
Default: empty

List of nested user groups. Specified by identifiers.
Via the API, group codes can be specified at creation and are automatically expanded to identifiers.

Field: opts
Mode: in
Type: object
Compound field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary title

Field: opts.comment
Mode: in
Type: empty
Default: "

Arbitrary comment

Field: opts.roles
Mode: in
Type: array<str>
Default: empty

List of group roles inherited by all users belonging to it.
Possible values are available via API roles.
Via the API at creation, they can be specified as a comma-separated string.

The full set of group roles is also determined by the group’s membership in other groups.
The entire set of roles assigned to groups is available via API groups_caches.

Field: security
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values.

Field: ext
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values.

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object

See also