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

General Information About Human Users

A human user represents an actual person. The human user can be linked to an account. If this link exists other users from within this particular account can manage the corresponding user.

A human user can have roles. Each role grants different permissions to the user. As part of the PCI DSS we have to force the user to change the password every 90 days.

Roles and Human Users

Human users have roles. Each role grants different permissions to the user. When creating and assigning roles you have to keep in mind that each role is context specific. There are access rights that are bound to the context of a space or an account. You can assign the role only in such a context.

States
  • Create
    The create state indicates that the Human User is in creation.
  • Active
    The active state indicates that the Human User is active and may be used.
  • Inactive
    The inactive state indicates that the Human User is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Human User is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Email Address
    The user's email address.
  • Email Address Verification
    Whether the user's email address has been verified.
  • First Name
    The user's first name.
  • ID
    A unique identifier for the object.
  • Language
    The user's preferred language.
  • Last Name
    The user's last name.
  • Mobile Phone Number
    The user's mobile phone number.
  • Mobile Phone Number Verification
    Whether the user's mobile phone number has been verified.
  • 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.
  • Primary Account
    The primary account that the user belongs to.
  • Scope
    The scope that the user belongs to.
  • State
    The object's current state.

    A human user can have the following states:

    Active

    When the state is set to Active this user can act.

    Inactive

    When the state is set to Inactive this user can’t act. However, all the information is not deleted and you can reactivate the user at any moment.

    Deleting

    The user is in the process of the deletion. This may take some time until the user is marked as Deleting before being marked as Deleted.

    Deleted

    The user is deleted. Since the user is linked with data which cannot be deleted immediately, we need to keep the user until all the data can be removed.

  • Time Zone
    The user's time zone. If none is specified, the one provided by the browser will be used.
  • Two Factor Type
    The type of two-factor authentication that is enabled for the user.
  • Two-Factor Authentication
    Whether two-factor authentication is enabled for this user.
  • 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.