Common data model

Access control

User record

Name

Multiplicity

Type

Description

name

1

string

The user’s name

active

1

bool

Whether the user’s account is active (true) or not (false)

user

1

bool

Whether the user has user rights. Should always be true. Deprecated as of 1.4.0, use the users group instead.

admin

1

bool

Whether the user has admin rights (true) or not (false). Deprecated as of 1.4.0, use the admins group instead.

apikey

0..1

string

The user’s personal API key

settings

1

object

The user’s personal settings, might be an empty object.

groups

1..n

List of string

Groups assigned to the user

needs

1

Needs object

Effective needs of the user

permissions

0..n

List of Permissions

The list of permissions assigned to the user (note: this does not include implicit permissions inherit from groups).

Permission record

Name

Multiplicity

Type

Description

key

1

string

The permission’s identifier

name

1

string

The permission’s name

dangerous

1

boolean

Whether the permission should be considered dangerous due to a high reponsibility (true) or not (false).

default_groups

1

List of string

List of group identifiers for which this permission is enabled by default

description

1

string

Human readable description of the permission

needs

1

Needs object

Needs assigned to the permission

Group record

Name

Multiplicity

Type

Description

key

1

string

The group’s identifier

name

1

string

The group’s name

description

1

string

A human readable description of the group

permissions

0..n

List of Permissions

The list of permissions assigned to the group (note: this does not include implicit permissions inherited from subgroups).

subgroups

0..n

List of Groups

Subgroups assigned to the group

needs

1

Needs object

Effective needs of the group

default

1

boolean

Whether this is a default group (true) or not (false)

removable

1

boolean

Whether this group can be removed (true) or not (false)

changeable

1

boolean

Whether this group can be modified (true) or not (false)

toggleable

1

boolean

Whether this group can be assigned to users or other groups (true) or not (false)

Needs

Name

Multiplicity

Type

Description

role

0..1

List of string

List of role needs

group

0..1

List of string

List of group needs