User model

The user model represents a user in Falcon.

id
integer

The id of the user.

hash
string

The unique hash of the user.

name
string

The display name of the user.

first_name
string

The first name of the user.

last_name
string

The last name of the user.

position
string

The position of the user.

department
string

The department of the user.

organization
string

The organization of the user.

email
string <email>

The email of the user.

domain
string

The domain of the user.

email_reports
boolean

The email reports flag of the user.

alias
string

The alias of the user.

mobile
string <mobile>

The mobile number of the user.

password_type
integer

The password type of the user.

  • 1 - Initial
  • 2 - Temporary
  • 3 - User

Enum: 1 2 3
password_modified_time
string <date-time>

The passwort modified time of the user.

password_age
integer >= 0

The age of the user password in days.

password_age_relative_time
string

The relative age of the user password.

login_time
string <date-time>

The login time of the user.

login_confirmation
boolean

The login confirmation flag indicates whether the user must complete their login with multifactor authentication.

login_confirmation_channel
integer

The login confirmation channel of the user used for multi factor authentication.

  • 1 - Email
  • 2 - SMS
  • 3 - Authenticator

Authenticator is used if the user has registered a corresponding app. SMS is used if the user has not registered an app, but has provided his mobile phone number. If neither an app nor a cell phone number has been registered, his email will be used. This is the minimum channel and cannot be deactivated.

Enum: 1 2 3
language
integer

The language of the user.

  • 0 - German
  • 1 - English

The language is derived from the user's locale settings and cannot be directly set.

Enum: 0 1
object <array>

The settings of the user.

status
integer

The status of the user.

  • 0 - Disabled
  • 1 - Active
  • 2 - Pending
Enum: 0 1 2
model
string

The user model.

Value: "User"
object or null (Image)

The avatar of the user.

object or null (UserInvitation)

The unprocessed invitation of the user.

object (UserHubPermission)

The hub permission of the user for the authenticated hub.

object or null (UserEmailVerification)

The unprocessed email verification of the user.

object or null (UserMobileVerification)

The unprocessed mobile verification of the user.

{
  • "id": 1,
  • "hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
  • "name": "Olli Kahn",
  • "first_name": "Olli",
  • "last_name": "Kahn",
  • "position": "CEO",
  • "department": "Engine room",
  • "organization": "Nordantech",
  • "email": "titan@nordantech.com",
  • "domain": "nordantech.com",
  • "email_reports": true,
  • "alias": "titan",
  • "mobile": "",
  • "password_type": 3,
  • "password_modified_time": "2022-05-04T16:51:37.000000Z",
  • "password_age": 0,
  • "password_age_relative_time": "1 hour ago",
  • "login_confirmation": false,
  • "login_confirmation_channel": 1,
  • "locale": 0,
  • "language": 0,
  • "settings": {
    },
  • "status": 2,
  • "model": "User",
  • "image": {
    },
  • "user_invitation": {
    },
  • "user_hub_permission": {
    },
  • "user_email_verification": null,
  • "user_mobile_verification": null
}
➔ Next to Workflow model