Difference between revisions of "USER"
From LongJump Support Wiki
imported>Aeric |
imported>Aeric |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Deprecated|The {{PAGENAME}} object still exists, but the description on this page is deprecated. For the most comprehensive information, consult the [[REST API:User Resource]].}} | |||
;Object ID:USER | ;Object ID:USER | ||
| Line 21: | Line 23: | ||
|country||String|| Country name | |country||String|| Country name | ||
|- | |- | ||
|{{Colorhighlight}}|email | |{{Colorhighlight}}|''email'' | ||
|{{Colorhighlight}}|String | |{{Colorhighlight}}|String | ||
|{{Colorhighlight}}|User Email Address | |{{Colorhighlight}}|User Email Address | ||
| Line 36: | Line 38: | ||
|last_login||Date||Time of the last login by this user | |last_login||Date||Time of the last login by this user | ||
|- | |- | ||
|{{Colorhighlight}}|last_name | |{{Colorhighlight}}|''last_name'' | ||
|{{Colorhighlight}}|String | |{{Colorhighlight}}|String | ||
|{{Colorhighlight}}|User last name | |{{Colorhighlight}}|User last name | ||
| Line 49: | Line 51: | ||
;Considerations: | ;Considerations: | ||
*Password is ''required'' for [[Login]] | *Password is ''required'' for [[Login]] | ||
*Password is ''optional'' when creating a new user via | *Password is ''optional'' when creating a new user via REST API V1.0 | ||
:*If password is not provided, a temporary password is generated and sent to the user/tenant via email | :*If password is not provided, a temporary password is generated and sent to the user/tenant via email | ||
::''Learn more: [[Manage_Email_Templates#User|Manage Email Templates - Forgot Reset Password Email]]'' | ::''Learn more: [[Manage_Email_Templates#User|Manage Email Templates - Forgot Reset Password Email]]'' | ||
| Line 61: | Line 63: | ||
:* Not supported for ''Update'' or ''Search'' | :* Not supported for ''Update'' or ''Search'' | ||
|- | |- | ||
|{{Colorhighlight}}| | |{{Colorhighlight}}|''access_profile_id'' | ||
|{{Colorhighlight}}|String | |{{Colorhighlight}}|String | ||
|{{Colorhighlight}}|User | |{{Colorhighlight}}|User's [[Access Profile]] identifier | ||
:* Required on ''Add'' action | :* Required on ''Add'' action | ||
:* Not supported for ''Update'' or ''Search'' | :* Not supported for ''Update'' or ''Search'' | ||
| Line 71: | Line 73: | ||
|street||String||User's street address | |street||String||User's street address | ||
|- | |- | ||
|{{Colorhighlight}}|time_zone | |{{Colorhighlight}}|''time_zone'' | ||
|{{Colorhighlight}}|Integer | |{{Colorhighlight}}|Integer | ||
|{{Colorhighlight}}|Time zone (See [[#Time Zone Codes|Time Zone Codes]] for details) | |{{Colorhighlight}}|Time zone (See [[#Time Zone Codes|Time Zone Codes]] for details) | ||
| Line 77: | Line 79: | ||
|title||String||Title | |title||String||Title | ||
|- | |- | ||
|{{Colorhighlight}}|username | |{{Colorhighlight}}|''username'' | ||
|{{Colorhighlight}}|String | |{{Colorhighlight}}|String | ||
|{{Colorhighlight}}|{{:Username}} | |{{Colorhighlight}}|{{:Username}} | ||
Latest revision as of 18:53, 19 October 2012
DEPRECATED: The USER object still exists, but the description on this page is deprecated. For the most comprehensive information, consult the REST API:User Resource.
- Object ID
- USER
Available Fields
- Required Fields are highlighted, in italics
- This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.
- Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:
- CALL_ACTION
- VIEW_ACTION
- Note: In this object, Boolean fields accept only 1 or 0 (not TRUE/FALSE)
Field Name Display Type Description active Boolean Specify if this user is active or not Default is 1 (new user is created as an active user)
city String City company String Company name country String Country name email String User Email Address employee_number String Employee number fax String Fax Number first_name String User first name force_password_change_on_login Boolean When enabled, the User is prompted to change the password when logging in for the first time Default is 1 (new user is forced to change password on first login)
last_login Date Time of the last login by this user last_name String User last name mobile String Mobile Number notify_by_email Boolean When enabled, a notification email is sent (containing the username, welcome and login information) when a new user is added Default is 1 (email is sent automatically, on new user creation)
password String Password used to login - Considerations
- Password is required for Login
- Password is optional when creating a new user via REST API V1.0
- If password is not provided, a temporary password is generated and sent to the user/tenant via email
phone String User's phone number reports_to String User's manager or supervisor (often used for approvals in workflows) team_id String ID of the user's primary team - Required on Add action
- Not supported for Update or Search
access_profile_id String User's Access Profile identifier - Required on Add action
- Not supported for Update or Search
state String State street String User's street address time_zone Integer Time zone (See Time Zone Codes for details) title String Title username String Username is a unique name associated with each User. Username is required to Login, can be an email address or an alphanumeric text string. zip String Zip code
Time Zone Codes
Code Time Zone 80 (GMT+14:00) Line Is. Time (Pacific/Kiritimati) 76 (GMT+13:00) Phoenix Is. Time (Pacific/Enderbury) 84 (GMT+13:00) Tonga Time (Pacific/Tongatapu) 75 (GMT+12:45) Chatham Daylight Time (Pacific/Chatham) 31 (GMT+12:00) Petropavlovsk-Kamchatski Time (Asia/Kamchatka) 74 (GMT+12:00) New Zealand Daylight Time (Pacific/Auckland) 77 (GMT+12:00) Fiji Time (Pacific/Fiji) 82 (GMT+11:30) Norfolk Time (Pacific/Norfolk) 78 (GMT+11:00) Solomon Is. Time (Pacific/Guadalcanal) 54 (GMT+10:30) Load Howe Summer Time (Australia/Lord Howe) 52 (GMT+10:00) Eastern Standard Time (Queensland) 56 (GMT+10:00) Eastern Summer Time (New South Wales) 51 (GMT+09:30) Central Summer Time (South Australia) 53 (GMT+09:30) Central Standard Time (Northern Territory) 40 (GMT+09:00) Korea Standard Time (Asia/Seoul) 46 (GMT+09:00) Japan Standard Time (Asia/Tokyo) 27 (GMT+08:00) Hong Kong Time (Asia/Hong Kong) 34 (GMT+08:00) Malaysia Time (Asia/Kuala Lumpur) 36 (GMT+08:00) Philippines Time (Asia/Manila) 57 (GMT+08:00) China Standard Time (Asia/Shanghai) 41 (GMT+08:00) Singapore Time (Asia/Singapore) 42 (GMT+08:00) China Standard Time (Asia/Taipei) 55 (GMT+08:00) Western Standard Time (Australia) 22 (GMT+07:00) Indochina Time (Asia/Bangkok) 28 (GMT+07:00) West Indonesia Time (Asia/Jakarta) 39 (GMT+07:00) Indochina Time (Asia/Saigon) 37 (GMT+06:30) Myanmar Time (Asia/Rangoon) 24 (GMT+06:00) Sri Lanka Time (Asia/Colombo) 25 (GMT+06:00) Bangladesh Time (Asia/Dacca) 33 (GMT+05:45) Nepal Time (Asia/Katmandu) 23 (GMT+05:30) India Standard Time (Asia/Calcutta) 32 (GMT+05:00) Pakistan Time (Asia/Karachi) 43 (GMT+05:00) Uzbekistan Time (Asia/Tashkent) 47 (GMT+05:00) Yekaterinburg Time (Asia/Yekaterinburg) 30 (GMT+04:30) Afghanistan Time (Asia/Kabul) 26 (GMT+04:00) Gulf Standard Time (Asia/Dubai) 44 (GMT+04:00) Georgia Time (Asia/Tbilisi) 45 (GMT+03:30) Iran Standard Time (Asia/Tehran) 3 (GMT+03:00) Eastern African Time (Africa/Nairobi) 21 (GMT+03:00) Arabia Standard Time (Asia/Baghdad) 35 (GMT+03:00) Arabia Standard Time (Asia/Kuwait) 38 (GMT+03:00) Arabia Standard Time (Asia/Riyadh) 69 (GMT+03:00) Moscow Standard Time (Europe/Moscow) 1 (GMT+02:00) Eastern European Time (Africa/Cairo) 2 (GMT+02:00) South Africa Standard Time (Africa/Johannesburg) 29 (GMT+02:00) Israel Standard Time (Asia/Jerusalem) 59 (GMT+02:00) Eastern European Time (Europe/Athens) 62 (GMT+02:00) Eastern European Time (Europe/Bucharest) 64 (GMT+02:00) Eastern European Time (Europe/Helsinki) 65 (GMT+02:00) Eastern European Time (Europe/Istanbul) 68 (GMT+02:00) Eastern European Time (Europe/Minsk) 58 (GMT+01:00) Central European Time (Europe/Amsterdam) 60 (GMT+01:00) Central European Time (Europe/Berlin) 61 (GMT+01:00) Central European Time (Europe/Brussels) 70 (GMT+01:00) Central European Time (Europe/Paris) 71 (GMT+01:00) Central European Time (Europe/Prague) 72 (GMT+01:00) Central European Time (Europe/Rome) 63 (GMT+00:00) Greenwich Mean Time (Europe/Dublin) 66 (GMT+00:00) Western European Time (Europe/Lisbon) 67 (GMT+00:00) Greenwich Mean Time (Europe/London) 73 (GMT+00:00) Greenwich Mean Time (GMT) 49 (GMT-01:00) Cape Verde Time (Atlantic/Cape Verde) 50 (GMT-02:00) South Georgia Standard Time (Atlantic/South Georgia) 6 (GMT-03:00) Argentine Time (America/Buenos Aires) 18 (GMT-03:00) Brazil Summer Time (America/Sao Paulo) 19 (GMT-03:30) Newfoundland Standard Time (America/St Johns) 7 (GMT-04:00) Venezuela Time (America/Caracas) 10 (GMT-04:00) Atlantic Standard Time (America/Halifax) 17 (GMT-04:00) Atlantic Standard Time (America/Puerto Rico) 48 (GMT-04:00) Atlantic Standard Time (Atlantic/Bermuda) 5 (GMT-05:00) Colombia Time (America/Bogota) 85 (GMT-05:00) Eastern Standard Time (America/Indianapolis) 11 (GMT-05:00) Peru Time (America/Lima) 14 (GMT-05:00) Eastern Standard Time (America/New York) 15 (GMT-05:00) Eastern Standard Time (America/Panama) 86 (GMT-06:00) Central Standard Time (Canada/Saskatchewan) 8 (GMT-06:00) Central Standard Time (America/Chicago) 13 (GMT-06:00) Central Standard Time (America/Mexico City) 9 (GMT-07:00) Mountain Standard Time (America/Denver) 16 (GMT-07:00) Mountain Standard Time (America/Phoenix) 12 (GMT-08:00) Pacific Standard Time (America/Los Angeles) 20 (GMT-08:00) Pacific Standard Time (America/Tijuana) 4 (GMT-09:00) Alaska Standard Time (America/Anchorage) 79 (GMT-10:00) Hawaii Standard Time (Pacific/Honolulu) 81 (GMT-11:00) Niue Time (Pacific/Niue) 83 (GMT-11:00) Samoa Standard Time (Pacific/Pago Pago)
- Standard Fields
The standard system fields are:
- Common to, and predefined in, all Objects.
- Created automatically when an object is created.
- Populated automatically when a record is added or updated in the GUI.
- Required when a record is added or updated using an API.
Field Name REST Search Name GUI Label Display Type Description object_id object_id Object ID Number Unique identifier for the object. (This field is always present, but is only displayed when examining Object metadata (the data that defines the object). record_id id Record ID Number Unique record identifier owner_id OWNERID Owner String Unique identifier of the record's owner owner_team_id OWNER_TEAM_ID n/a String Unique identifier of record owner's primary team. (This is a virtual field that does not actually exist in the record. The actual field is in the User object. It is returned in APIs, to keep from having to access the database a second time to check permissions.) created_id CREATEDID Created By String Unique identifier of the user who created the record date_created DATECREATED Date Created String Date the record was created: - UTC Format in the REST API.
- User's Date Format in the GUI and the Java API.
date_modified DATEMODIFIED Date Modified String Date the record was last modified: - UTC Format in the REST API.
- User's Date Format in the GUI and the Java API.
modified_id MODIFIEDID Modified By String Unique identifier of the user who last modified the record