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

The user represents a single user. Essentially there are four different types:

  • Human User: A human user represents a person.

  • Application User: A application user represents an application.

  • Anonymous User: An anonymous user represents a not authenticated user.

  • Server User: The server user represents our web server. In case some repeating actions needs to be executed this user may be identified as the acting user.

States
  • Create
    The create state indicates that the User is in creation.
  • Active
    The active state indicates that the User is active and may be used.
  • Inactive
    The inactive state indicates that the User is inactive and may not be used.
  • Deleting
    The deleting state indicates that the User is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • ID
    A unique identifier for the object.
  • 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.
  • Scope
    The scope that the user belongs to.
  • State
    The object's current state.
  • User Type
    The user's type which defines its role and capabilities.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.