UserModifiableFields

These are fields in the User object that can be modified (not necessarily by the user in question) or given as input when creating a new User.

tip

Note that only user_login and fullname are required when creating a new User.

Note: If using SSO (Single Sign-On), the user_login field usually needs to match the user's email address, UPN, or other primary identifier in the external authentication system.

warning

The new_pw, new_pw2, and expire_new_pw fields should only be used when intending to change the user's password.

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

iduuid

The Group ID.

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsuuid[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

statusstring

The status of the user; either hidden, active, or inactive.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

expense_guistring

The Entry Screen ID (aka GUI) of the user's Expense Entry screen.

time_guistring

The Entry Screen ID (aka GUI) of the user's Time Entry screen.

travel_guistring

The Entry Screen ID (aka GUI) of the user's Custom Entry screen.

UserModifiableFields

{
  "user_login": "john.smith@example.com",
  "fullname": "John Smith",
  "u_comment": "string",
  "status": "string",
  "default_memorized_sheet": "string",
  "dropdownthreshold": 0,
  "hide": true,
  "expire_new_pw": true,
  "new_pw": "string",
  "new_pw2": "string",
  "roles": [
    "string"
  ],
  "timerecs_in": 3,
  "time_period": "default_weekly",
  "expense_period": "default_weekly",
  "custom_period": "default_weekly",
  "expense_gui": "string",
  "time_gui": "string",
  "travel_gui": "string",
  "group_names": [
    {
      "id": "5088C427E8B64EBEBE1C5B5961DB1902",
      "pname": "Sales"
    },
    {
      "id": "3553F715A6F54DAB95D0D25B08468195",
      "pname": "Accounting"
    }
  ],
  "groups": [
    "5088C427E8B64EBEBE1C5B5961DB1902",
    "3553F715A6F54DAB95D0D25B08468195"
  ]
}