Documentation
Documentation
    • English (United States)
Role
Close API Documentation
Role

You can define different roles inside the application. Roles can then be assigned to a human or application user.

Roles are cumulative and inherited. This means that the access rights of the different roles positively accumulate up for a user.

States
  • Create
    The create state indicates that the role is in creation.
  • Active
    The active state indicates that the role is active and may be used.
  • Deleting
    The deleting state indicates that the role is in the process to be deleted.
  • Deleted
    The deleted state marks the role for purging from the database.
Properties
  • Account
    The account to which this role belongs to. This role can only be assigned within the assigned account and the sub accounts of the assigned account.
  • ID
    A unique identifier for the object.
  • Name
    The name of this role is used to identify the role within administrative interfaces.
  • Permissions
    Set of permissions that are granted to this role.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • State
    The object's current state.
  • Two-Factor Authentication Required
    Defines whether having been granted this role will force a user to use two-factor authentication.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.