User (user)
Description
User account of the system in a domain.
Defines authorization parameters and access boundaries to system functionality through HTTP and WebSocket API. The user’s role set determines the level of API access.
Limitations
-
The collection is available in any domain. Each domain can have a special set of roles (opts.roles) for users.
-
The system’s operating logic uses domains and the objects belonging to them when implementing functionality and determining access for individual users. All data within a domain is closed by default. However, user accounts are available to administrators of the parent domain. Belongs to the data layer.
Fields
{
"id": uuid,
"name": str,
"login": str,
"pwd": str,
"timezone": float | 'default',
"opts": {
"title": str,
"roles": array<str>,
"tags": array<str>,
"copy_to_domains": array<str>,
"comment": str,
"sites": array<str>,
"allow_script_crud": bool
},
"security": object,
"ext": {
"ct": date,
"lwt": date,
...
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Field: |
User name. |
Field: |
User login. |
Field: |
User password. |
Field: |
User time zone. From -12 to 12, for example 3.5, or "default" to use the server time zone. |
Field: |
|
Field: |
List of roles assigned to the user personally. The full set of user roles is also determined by the user’s membership in groups. For master domain accounts that are copied to other domains ('copy_to_domains'), it may be necessary to specify product layer roles installed in the child domain. Such roles are not present in the master domain role list and must be specified manually. For a user to be able to modify entities of static collections of the domain center, at least one of the roles must be assigned: 'admin', 'crud', 'crud.*' (where * is an arbitrary string). It must be assigned directly in the user account (in this field). Otherwise the domain center will not allow the modification request, even if the role routes allow it. |
Field: |
List of user tags. |
Field: |
Domain masks.
Examples:
|
Field: |
Set to 'true' by the system when created during self-registration of a user. |
Field: |
Filled by the system during automatic registration or when updating data in an external system during OAuth authorization. |
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
Field: |
List of sites to restrict data access. The field exists only in the master domain for users with the |
Field: |
Switch allowing CRUD operations from scripts on behalf of this user. |
Field: |
Maximum number of web sessions for the user. The number is defined as 1 cookie session + n token sessions. If authentication exceeds the session limit, a web session limit exceeded error is returned. |
Field: |
User phone number applied to the sipuser account during hot-desking via the Hot-Desk subscriber feature or from a client application. |
Field: |
User PIN code used for hot-desking the user and the sipuser account via the Hot-Desk subscriber feature. |
Field: |
Allows extending the compound with arbitrary keys and values. Not available for viewing or modification by the user. |
Field: |
Allows extending the compound with arbitrary keys and values. Available for viewing and modification by the user. |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Field: |
List of sections of the 'Settings' application available to the administrator account. |