User group (group)

Table of Contents

Description
Fields
See also
- API

Description

Defines sets of roles. Includes users. Can include other groups (no loops).
If groups are configured, it is enough to include a user in one of them - the roles will be defined for him automatically.
However, the admin role must be assigned directly to at least one of the domain users.

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
  }
}

Description of the specification’s characteristics

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 who are members of the group. Defined by identifiers. Through the API, logins are supported to be specified at creation, automatically expanded into identifiers.
Field: `groups` Mode: `in` Type: `array` Default: empty	List of nested user groups. Defined by identifiers. Through the API it is supported to specify group codes at creation, automatically expanded into identifiers.
Field: `opts` Mode: `in` Type: `object` Composite field
Field: `opts.title` Mode: `in` Type: `str` Default: empty	Arbitrary header
Field: `opts.comment` Mode: `in` Type: `empty` Default: "	Arbitrary comment
Field: `opts.roles` Mode: `in` Type: `array<str>` Default: empty	A list of group roles inherited by all the users in the group. Possible values are available via API roles. Through the API, specifying as a comma-separated string is supported during creation. The full set of roles of a group 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 you to extend the compound with arbitrary keys and values.
Field: `ext` Mode: `inout` Type: `object` Compound field	Allows you to extend 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

User group (group)

Description

Fields

See also

API